merge from 2.2
[samba.git] / docs / docbook / projdoc / msdfs_setup.sgml
1 <chapter>
2
3 <chapterinfo>
4         <author>
5                 <firstname>Shirish</firstname><surname>Kalele</surname>
6                 <affiliation>
7                         <orgname>Samba Team & Veritas Software</orgname>
8                         <address>
9                                 <email>samba@samba.org</email>
10                         </address>
11                 </affiliation>
12         </author>
13         
14                 
15         <pubdate>12 Jul 200</pubdate>
16 </chapterinfo>
17
18
19 <title>Hosting a Microsoft Distributed File System tree on Samba</title>
20
21 <sect1>
22
23         <title>Instructions</title>
24
25         <para>The Distributed File System (or Dfs) provides a means of 
26         separating the logical view of files and directories that users 
27         see from the actual physical locations of these resources on the 
28         network. It allows for higher availability, smoother storage expansion, 
29         load balancing etc. For more information about Dfs, refer to  <ulink 
30         url="http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp">
31         Microsoft documentation</ulink>. </para>
32
33         <para>This document explains how to host a Dfs tree on a Unix 
34         machine (for Dfs-aware clients to browse) using Samba.</para>
35
36         <para>To enable SMB-based DFS for Samba, configure it with the 
37         <parameter>--with-msdfs</parameter> option. Once built, a 
38         Samba server can be made a Dfs server by setting the global 
39         boolean <ulink url="smb.conf.5.html#HOSTMSDFS"><parameter>
40         host msdfs</parameter></ulink> parameter in the <filename>smb.conf
41         </filename> file. You designate a share as a Dfs root using the share 
42         level boolean <ulink url="smb.conf.5.html#MSDFSROOT"><parameter>
43         msdfs root</parameter></ulink> parameter. A Dfs root directory on 
44         Samba hosts Dfs links in the form of symbolic links that point 
45         to other servers. For example, a symbolic link
46         <filename>junction-&gt;msdfs:storage1\share1</filename> in 
47         the share directory acts as the Dfs junction. When Dfs-aware 
48         clients attempt to access the junction link, they are redirected 
49         to the storage location (in this case, \\storage1\share1).</para>
50
51         <para>Dfs trees on Samba work with all Dfs-aware clients ranging 
52         from Windows 95 to 2000.</para>
53         
54         <para>Here's an example of setting up a Dfs tree on a Samba 
55         server.</para>
56
57         <para><programlisting>
58 # The smb.conf file:
59 [global]
60         netbios name = SAMBA
61         host msdfs   = yes
62
63 [dfs]
64         path = /export/dfsroot
65         msdfs root = yes
66         </programlisting></para>
67
68
69         <para>In the /export/dfsroot directory we set up our dfs links to 
70         other servers on the network.</para>
71
72         <para><prompt>root# </prompt><userinput>cd /export/dfsroot</userinput></para>
73         <para><prompt>root# </prompt><userinput>chown root /export/dfsroot</userinput></para>
74         <para><prompt>root# </prompt><userinput>chmod 755 /export/dfsroot</userinput></para>
75         <para><prompt>root# </prompt><userinput>ln -s msdfs:storageA\\shareA linka</userinput></para>
76         <para><prompt>root# </prompt><userinput>ln -s msdfs:serverB\\share,serverC\\share linkb</userinput></para>
77
78
79         <para>You should set up the permissions and ownership of 
80         the directory acting as the Dfs root such that only designated 
81         users can create, delete or modify the msdfs links. Also note 
82         that symlink names should be all lowercase. This limitation exists 
83         to have Samba avoid trying all the case combinations to get at 
84         the link name. Finally set up the symbolic links to point to the 
85         network shares you want, and start Samba.</para>
86
87         <para>Users on Dfs-aware clients can now browse the Dfs tree 
88         on the Samba server at \\samba\dfs. Accessing 
89         links linka or linkb (which appear as directories to the client) 
90         takes users directly to the appropriate shares on the network.</para>
91
92         <sect2>
93                 <title>Notes</title>
94
95                 <itemizedlist>
96                         <listitem><para>Windows clients need to be rebooted 
97                         if a previously mounted non-dfs share is made a dfs 
98                         root or vice versa. A better way is to introduce a 
99                         new share and make it the dfs root.</para>
100                         </listitem>
101                         
102                         <listitem><para>Currently there's a restriction that msdfs 
103                         symlink names should all be lowercase.</para>
104                         </listitem>
105                         
106                         <listitem><para>For security purposes, the directory 
107                         acting as the root of the Dfs tree should have ownership 
108                         and permissions set so that only designated users can 
109                         modify the symbolic links in the directory.</para>
110                         </listitem>
111                 </itemizedlist>
112         </sect2>
113 </sect1>
114
115
116         
117 </chapter>