diff options
Diffstat (limited to 'docs/docbook/projdoc/VFS.xml')
| -rw-r--r-- | docs/docbook/projdoc/VFS.xml | 378 |
1 files changed, 215 insertions, 163 deletions
diff --git a/docs/docbook/projdoc/VFS.xml b/docs/docbook/projdoc/VFS.xml index 225411b427..67f1b39a99 100644 --- a/docs/docbook/projdoc/VFS.xml +++ b/docs/docbook/projdoc/VFS.xml @@ -2,169 +2,213 @@ <chapterinfo> &author.jelmer; &author.jht; - <author><firstname>Alexander</firstname><surname>Bokovoy</surname></author> <author><firstname>Tim</firstname><surname>Potter</surname></author> - <author><firstname>Simo</firstname><surname>Sorce</surname></author> + <author><firstname>Simo</firstname><surname>Sorce</surname><contrib>original vfs_skel README</contrib></author> + <author><firstname>Alexander</firstname><surname>Bokovoy</surname><contrib>original vfs_netatalk docs</contrib></author> + <author><firstname>Stefan</firstname><surname>Metzmacher</surname><contrib>Update for multiple modules</contrib></author> </chapterinfo> <title>Stackable VFS modules</title> <sect1> -<title>Introduction and configuration</title> +<title>Features and Benefits</title> <para> -Since samba 3.0, samba supports stackable VFS(Virtual File System) modules. +Since Samba-3, there is support for stackable VFS(Virtual File System) modules. Samba passes each request to access the unix file system thru the loaded VFS modules. This chapter covers all the modules that come with the samba source and references to some external modules. </para> -<para> -You may have problems to compile these modules, as shared libraries are -compiled and linked in different ways on different systems. -They currently have been tested against GNU/linux and IRIX. -</para> -<para> -To use the VFS modules, create a share similar to the one below. The -important parameter is the <command>vfs object</command> parameter which must point to -the exact pathname of the shared library objects. For example, to log all access -to files and use a recycle bin: +</sect1> -<programlisting> - [audit] - comment = Audited /data directory - path = /data - vfs object = /path/to/audit.so /path/to/recycle.so - writeable = yes - browseable = yes -</programlisting> -</para> +<sect1> +<title>Discussion</title> <para> -The modules are used in the order they are specified. +If not supplied with your platform distribution binary Samba package you may have problems +to compile these modules, as shared libraries are compiled and linked in different ways +on different systems. They currently have been tested against GNU/Linux and IRIX. </para> <para> -Further documentation on writing VFS modules for Samba can be found in -the Samba Developers Guide. -</para> - -</sect1> - -<sect1> -<title>Included modules</title> +To use the VFS modules, create a share similar to the one below. The +important parameter is the <command>vfs objects</command> parameter where +you can list one or more VFS modules by name. For example, to log all access +to files and put deleted files in a recycle bin: -<sect2> -<title>audit</title> -<para>A simple module to audit file access to the syslog -facility. The following operations are logged: -<simplelist> -<member>share</member> -<member>connect/disconnect</member> -<member>directory opens/create/remove</member> -<member>file open/close/rename/unlink/chmod</member> -</simplelist> +<programlisting> +[audit] + comment = Audited /data directory + path = /data + vfs objects = audit recycle + writeable = yes + browseable = yes +</programlisting> </para> -</sect2> -<sect2> -<title>extd_audit</title> <para> -This module is identical with the <emphasis>audit</emphasis> module above except -that it sends audit logs to both syslog as well as the smbd log file/s. The -loglevel for this module is set in the smb.conf file. +The modules are used in the order in which they are specified. </para> <para> -The logging information that will be written to the smbd log file is controlled by -the <emphasis>log level</emphasis> parameter in <filename>smb.conf</filename>. The -following information will be recorded: +Samba will attempt to load modules from the <emphasis>lib</emphasis> +directory in the root directory of the samba installation (usually +<filename>/usr/lib/samba/vfs</filename> or <filename>/usr/local/samba/lib/vfs +</filename>). </para> -<table frame="all"><title>Extended Auditing Log Information</title> -<tgroup cols="2" align="center"> - <thead> - <row><entry align="center">Log Level</entry><entry>Log Details - File and Directory Operations</entry></row> - </thead> - <tbody> - <row><entry align="center">0</entry><entry align="left">Creation / Deletion</entry></row> - <row><entry align="center">1</entry><entry align="left">Create / Delete / Rename / Permission Changes</entry></row> - <row><entry align="center">2</entry><entry align="left">Create / Delete / Rename / Perm Change / Open / Close</entry></row> - </tbody> -</tgroup> -</table> - -</sect2> - -<sect2> -<title>recycle</title> <para> -A recycle-bin like module. When used any unlink call -will be intercepted and files moved to the recycle -directory instead of being deleted. -</para> +Some modules can be used twice for the same share. +This can be done using a configuration similar to the one below. -<para>Supported options: -<variablelist> - <varlistentry> - <term>vfs_recycle_bin:repository</term> - <listitem><para>FIXME</para></listitem> - </varlistentry> - - <varlistentry> - <term>vfs_recycle_bin:keeptree</term> - <listitem><para>FIXME</para></listitem> - </varlistentry> - - <varlistentry> - <term>vfs_recycle_bin:versions</term> - <listitem><para>FIXME</para></listitem> - </varlistentry> - - <varlistentry> - <term>vfs_recycle_bin:touch</term> - <listitem><para>FIXME</para></listitem> - </varlistentry> - - <varlistentry> - <term>vfs_recycle_bin:maxsize</term> - <listitem><para>FIXME</para></listitem> - </varlistentry> - - <varlistentry> - <term>vfs_recycle_bin:exclude</term> - <listitem><para>FIXME</para></listitem> - </varlistentry> - - <varlistentry> - <term>vfs_recycle_bin:exclude_dir</term> - <listitem><para>FIXME</para></listitem> - </varlistentry> - - <varlistentry> - <term>vfs_recycle_bin:noversions</term> - <listitem><para>FIXME</para></listitem> - </varlistentry> -</variablelist> +<programlisting> +[test] + comment = VFS TEST + path = /data + writeable = yes + browseable = yes + vfs objects = example:example1 example example:test + example1: parameter = 1 + example: parameter = 5 + test: parameter = 7 +</programlisting> </para> -</sect2> - -<sect2> -<title>netatalk</title> -<para> -A netatalk module, that will ease co-existence of samba and -netatalk file sharing services. -</para> +</sect1> -<para>Advantages compared to the old netatalk module: -<simplelist> -<member>it doesn't care about creating of .AppleDouble forks, just keeps them in sync</member> -<member>if share in smb.conf doesn't contain .AppleDouble item in hide or veto list, it will be added automatically</member> -</simplelist> -</para> +<sect1> +<title>Included modules</title> -</sect2> + <sect2> + <title>audit</title> + + <para> + A simple module to audit file access to the syslog + facility. The following operations are logged: + <simplelist> + <member>share</member> + <member>connect/disconnect</member> + <member>directory opens/create/remove</member> + <member>file open/close/rename/unlink/chmod</member> + </simplelist> + </para> + + </sect2> + + <sect2> + <title>extd_audit</title> + + <para> + This module is identical with the <emphasis>audit</emphasis> module above except + that it sends audit logs to both syslog as well as the smbd log file/s. The + loglevel for this module is set in the smb.conf file. + </para> + + <para> + The logging information that will be written to the smbd log file is controlled by + the <parameter>log level</parameter> parameter in <filename>smb.conf</filename>. The + following information will be recorded: + </para> + + <table frame="all"><title>Extended Auditing Log Information</title> + <tgroup cols="2" align="center"> + <thead> + <row><entry align="center">Log Level</entry><entry>Log Details - File and Directory Operations</entry></row> + </thead> + <tbody> + <row><entry align="center">0</entry><entry align="left">Creation / Deletion</entry></row> + <row><entry align="center">1</entry><entry align="left">Create / Delete / Rename / Permission Changes</entry></row> + <row><entry align="center">2</entry><entry align="left">Create / Delete / Rename / Perm Change / Open / Close</entry></row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2> + <title>fake_perms</title> + + <para> + This module was created to allow Roaming Profile files and directories to be set (on the Samba server + under Unix) as read only. This module will if installed on the Profiles share will report to the client + that the Profile files and directories are writable. This satisfies the client even though the files + will never be overwritten as the client logs out or shuts down. + </para> + + </sect2> + + <sect2> + <title>recycle</title> + + <para> + A recycle-bin like module. When used any unlink call + will be intercepted and files moved to the recycle + directory instead of being deleted. + </para> + + <para>Supported options: + <variablelist> + <varlistentry> + <term>recycle:repository</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:keeptree</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:versions</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:touch</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:maxsize</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:exclude</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:exclude_dir</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>recycle:noversions</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + </variablelist> + </para> + + </sect2> + + <sect2> + <title>netatalk</title> + + <para> + A netatalk module, that will ease co-existence of samba and + netatalk file sharing services. + </para> + + <para>Advantages compared to the old netatalk module: + <simplelist> + <member>it doesn't care about creating of .AppleDouble forks, just keeps them in sync</member> + <member>if a share in &smb.conf; doesn't contain .AppleDouble item in hide or veto list, it will be added automatically</member> + </simplelist> + </para> + + </sect2> </sect1> @@ -179,52 +223,60 @@ to have his or her own CVS tree). </para> <para> -No statemets about the stability or functionality of any module +No statements about the stability or functionality of any module should be implied due to its presence here. </para> -<sect2> -<title>DatabaseFS</title> + <sect2> + <title>DatabaseFS</title> -<para> -URL: <ulink url="http://www.css.tayloru.edu/~elorimer/databasefs/index.php">http://www.css.tayloru.edu/~elorimer/databasefs/index.php</ulink> -</para> + <para> + URL: <ulink url="http://www.css.tayloru.edu/~elorimer/databasefs/index.php">http://www.css.tayloru.edu/~elorimer/databasefs/index.php</ulink> + </para> -<para>By <ulink url="mailto:elorimer@css.tayloru.edu">Eric Lorimer</ulink>.</para> + <para>By <ulink url="mailto:elorimer@css.tayloru.edu">Eric Lorimer</ulink>.</para> -<para> -I have created a VFS module which implements a fairly complete read-only -filesystem. It presents information from a database as a filesystem in -a modular and generic way to allow different databases to be used -(originally designed for organizing MP3s under directories such as -"Artists," "Song Keywords," etc... I have since applied it to a student -roster database very easily). The directory structure is stored in the -database itself and the module makes no assumptions about the database -structure beyond the table it requires to run. -</para> + <para> + I have created a VFS module which implements a fairly complete read-only + filesystem. It presents information from a database as a filesystem in + a modular and generic way to allow different databases to be used + (originally designed for organizing MP3s under directories such as + "Artists," "Song Keywords," etc... I have since applied it to a student + roster database very easily). The directory structure is stored in the + database itself and the module makes no assumptions about the database + structure beyond the table it requires to run. + </para> -<para> -Any feedback would be appreciated: comments, suggestions, patches, -etc... If nothing else, hopefully it might prove useful for someone -else who wishes to create a virtual filesystem. -</para> + <para> + Any feedback would be appreciated: comments, suggestions, patches, + etc... If nothing else, hopefully it might prove useful for someone + else who wishes to create a virtual filesystem. + </para> -</sect2> + </sect2> -<sect2> -<title>vscan</title> -<para>URL: <ulink url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para> + <sect2> + <title>vscan</title> -<para> -samba-vscan is a proof-of-concept module for Samba, which -uses the VFS (virtual file system) features of Samba 2.2.x/3.0 -alphaX. Of couse, Samba has to be compiled with VFS support. -samba-vscan supports various virus scanners and is maintained -by Rainer Link. -</para> + <para>URL: <ulink url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para> -</sect2> + <para> + samba-vscan is a proof-of-concept module for Samba, which + uses the VFS (virtual file system) features of Samba 2.2.x/3.0 + alphaX. Of course, Samba has to be compiled with VFS support. + samba-vscan supports various virus scanners and is maintained + by Rainer Link. + </para> + </sect2> </sect1> +<sect1> +<title>Common Errors</title> + +<para> +There must be some gotchas we should record here! Jelmer??? +</para> + +</sect1> </chapter> |