examples/VFS/README

   1 README for Samba Virtual File System (VFS) Examples
   2 ===================================================
   3
   4 This directory contains some sample code to demonstrate VFS
   5 construction.  The following VFS modules are given:
   6
   7         skel
   8                 A skeleton VFS module.  When used, this module simply
   9                 passes all requests back to the disk functions (i.e it
  10                 operates as a passthrough filter).  It should be
  11                 useful as a starting point for developing new VFS
  12                 modules.
  13
  14         audit
  15                 A simple module to audit file access to the syslog
  16                 facility.  The following operations are logged: share
  17                 connect/disconnect, directory opens/create/remove,
  18                 file open/close/rename/unlink/chmod.
  19
  20         recycle
  21                 A recycle-bin like modules. When used any unlink call
  22                 will be intercepted and files moved to the recycle
  23                 directory nstead of beeing deleted.
  24
  25         block
  26                 A simple module to block access to certain mount points or
  27                 directories. This module only hides the specified directories
  28                 and all directories beneath them. It should NOT be used to
  29                 secure directories. If the name of a file in one of those
  30                 directories is known, the file can still be opened.
  31
  32         netatalk
  33                 A netatalk module, that will ease co-existence of samba and
  34                 netatalk file sharing services.
  35                 Looka t the README for more informations.
  36
  37 You may have problems to compile these modules, as shared libraries are
  38 compiled and linked in different ways on different systems.
  39 I currently tested them against GNU/linux and IRIX.
  40
  41 To use the VFS modules, create a share similar to the one below.  The
  42 important parameter is the 'vfs object' parameter which must point to
  43 the exact pathname of the shared library object.
  44
  45        [audit]
  46                 comment = Audited /data directory
  47                 path = /data
  48                 vfs object = /path/to/audit.so
  49                 writeable = yes
  50                 browseable = yes
  51
  52 Further documentation on writing VFS modules for Samba can be found in
  53 docs directory of the Samba source distribution.