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         block
  21                 A simple module to block access to certain mount points or
  22                 directories. This module only hides the specified directories
  23                 and all directories beneath them. It should NOT be used to secure
  24                 directories. If the name of a file in one of those directories is
  25                 known, the file can still be opened.
  26
  27 The libtool program, available from your favourite GNU software
  28 archive, is required to compile these programs.
  29
  30 To use the VFS modules, create a share similar to the one below.  The
  31 important parameter is the 'vfs object' parameter which must point to
  32 the exact pathname of the shared library object.
  33
  34        [audit]
  35                 comment = Audited /data directory
  36                 path = /data
  37                 vfs object = /path/to/audit.so
  38                 writeable = yes
  39                 browseable = yes
  40
  41 Further documentation on writing VFS modules for Samba can be found in
  42 docs directory of the Samba source distribution.