docs-xml/manpages/vfs_widelinks.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_widelinks.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_widelinks</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_widelinks</refname>
  16         <refpurpose>make a Samba share ignore filesystem symbolic links inside a share</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = widelinks</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>The <command>vfs_widelinks</command> VFS module
  33         hides the existence of symbolic links in the filesystem
  34         inside a share. It is used in Samba verson 4.13 and above
  35         to implement the <filename>smb.conf</filename>"wide links = yes"
  36         functionality that used to be inside the core smbd code.
  37         The module should not be loaded explicitly by smb.conf
  38         as part of the "vfs objects =" parameter, but is loaded
  39         implicitly when "wide links = yes" is enabled. This is
  40         to prevent existing smb.conf files from having to be
  41         modified to keep the existing insecure "wide links"
  42         functionality on a share.
  43         </para>
  44         <para>Please note that "wide links = yes" functionality
  45         is a deliberately insecure option, and should never be
  46         used in Samba installations. On Linux, bind mounts can
  47         be used instead to implement anything "wide links = yes"
  48         can enable. This module has been created to provide
  49         backwards compatibility with existing users of
  50         "wide links = yes" installations, but this use cannot be
  51         recommended and is not endorsed by the Samba developers.
  52         </para>
  53         <para>Note that this implicit loading may become explicit
  54         in a later Samba release, and administrators wishing to
  55         keep the insecure "wide links" functionality may have
  56         to add this module into their "vfs objects =" module
  57         list. The Samba project release notes and this manpage
  58         will be updated to reflect this when this change is made.
  59         </para>
  60
  61         <para>This module is stackable.</para>
  62
  63 </refsect1>
  64
  65 <refsect1>
  66         <title>EXAMPLES</title>
  67
  68         <para>No examples listed. This module is implicitly loaded
  69         by smbd as needed.
  70         </para>
  71 </refsect1>
  72
  73 <refsect1>
  74         <title>VERSION</title>
  75
  76         <para>This man page is part of version &doc.version; of the Samba suite.
  77         </para>
  78 </refsect1>
  79
  80 <refsect1>
  81         <title>AUTHOR</title>
  82
  83         <para>The original Samba software and related utilities
  84         were created by Andrew Tridgell. Samba is now developed
  85         by the Samba Team as an Open Source project similar
  86         to the way the Linux kernel is developed.</para>
  87
  88 </refsect1>
  89
  90 </refentry>