howto: Clarify differences when working from a tarball instead of Git.
[samba.git] / howto.txt
1 Samba4 developer howto
2 ======================
3
4 tridge@samba.org, December 2004
5
6 A more up to date version of this howto can be found in the wiki 
7 at http://wiki.samba.org/index.php/Samba4/HOWTO.
8
9 This is a very basic document on how to setup a simple Samba4
10 server. This is aimed at developers who are already familiar with
11 Samba3 and wish to participate in Samba4 development. This is not
12 aimed at production use of Samba4.
13
14 .. contents::
15
16 Step 1: download Samba4
17 -----------------------
18
19 If you have downloaded the Samba4 code via a tarball released from the
20 samba.org website, Step 1 has already been completed for you.  For testing
21 with the version released in the tarball, you may continue on to Step 2.  Note
22 that the references below to the top-level directory named "samba4" will
23 instead be based on the name of the tarball downloaded (e.g.
24 "samba-4.0.0alpha3" for the tarball samba-4.0.0alpha3.tar.gz).
25
26 There are 2 methods of doing this:
27
28   method 1:  "rsync -avz samba.org::ftp/unpacked/samba_4_0_test/ samba4"
29
30   method 2:  "git clone git://git.samba.org/samba.git samba4; cd samba4; git checkout v4-0-test; cd .."
31
32 both methods will create a directory called "samba4" in the current
33 directory. If you don't have rsync or git then install one of them. 
34
35 Since only released versions of Samba contain a pregenerated configure script, 
36 you will have to generate it by hand::
37
38  $ cd samba4/source
39  $ ./autogen.sh
40
41 Note that the above rsync command will give you a checked out git
42 repository. So if you also have git you can update it to the latest
43 version at some future date using::
44
45   $ cd samba4
46   $ git pull origin v4-0-test
47
48 Step 2: compile Samba4
49 ----------------------
50
51 Recommended optional development libraries:
52 - acl and xattr development libraries
53 - gnutls
54 - readline
55
56 Run this::
57
58   $ cd samba4/source
59   $ ./configure
60   $ make proto all
61
62 If you have gcc 3.4 or newer, then substitute "pch" for "proto" to
63 greatly speed up the compile process (about 5x faster).
64
65 Step 3: install Samba4
66 ----------------------
67
68 Run this as a user who have permission to write to the install
69 directory (defaults to /usr/local/samba). Use --prefix option to
70 configure above to change this.
71
72 ::
73  
74   # make install
75
76
77 Step 4: provision Samba4
78 ------------------------
79
80 The "provision" step sets up a basic user database. 
81 Must be run as a user with permission to write to the install directory.
82
83 ::
84
85   # cd source
86   # bin/smbpython ./setup/provision --realm=YOUR.REALM --domain=YOURDOM \
87   #  --adminpass=SOMEPASSWORD --server-role='domain controller'
88
89 REMINDER: Use the path to smbpython, as the provision command
90           will not work with the system python.
91
92 'YOURDOM' is the NT4 style domain name. 'YOUR.REALM' is your kerberos
93 realm, which is typically your DNS domain name.
94
95 Step 5: Create a simple smb.conf
96 --------------------------------
97
98 The provisioning will create a very simple smb.conf with no shares by
99 default. You will need to update it to add at least one share. For
100 example::
101
102   [test]
103         path = /data/test
104         read only = no
105
106
107 Step 6: starting Samba4
108 -----------------------
109
110 The simplest is to just run "smbd", but as a developer you may find
111 the following more useful::
112
113    # smbd -i -M single
114
115 that means "start smbd without messages in stdout, and running a
116 single process. That mode of operation makes debugging smbd with gdb
117 particularly easy.
118
119 Note that now it is no longer necessary to have an instance of nmbd
120 from Samba 3 running.  If you are running any smbd or nmbd processes
121 they need to be stopped before starting smbd from Samba 4.
122
123 Make sure you put the bin and sbin directories from your new install
124 in your $PATH. Make sure you run the right version!
125
126
127 Step 7: testing Samba4
128 ----------------------
129
130 try these commands::
131
132   $ smbclient //localhost/test -Uadministrator%SOMEPASSWORD
133
134 or::
135
136   $ ./script/tests/test_posix.sh //localhost/test administrator SOMEPASSWORD
137
138
139 NOTE about filesystem support
140 -----------------------------
141
142 To use the advanced features of Samba4 you need a filesystem that
143 supports both the "user" and "system" xattr namespaces.
144
145 If you run Linux with a 2.6 kernel and ext3 this means you need to
146 include the option "user_xattr" in your /etc/fstab. For example::
147
148    /dev/hda3            /home                   ext3    user_xattr     1 1
149
150 You also need to compile your kernel with the XATTR and SECURITY
151 options for your filesystem. For ext3 that means you need::
152
153    CONFIG_EXT3_FS_XATTR=y
154    CONFIG_EXT3_FS_SECURITY=y
155
156 If you are running a Linux 2.6 kernel with CONFIG_IKCONFIG_PROC
157 defined you can check this with the following command::
158
159    $ zgrep CONFIG_EXT3_FS /proc/config.gz
160
161 If you don't have a filesystem with xattr support, then you can
162 simulate it by using the option::
163
164    posix:eadb = /usr/local/samba/eadb.tdb
165
166 that will place all extra file attributes (NT ACLs, DOS EAs, streams
167 etc), in that tdb. It is not efficient, and doesn't scale well, but at
168 least it gives you a choice when you don't have a modern filesystem.
169
170 Testing your filesystem
171 -----------------------
172
173 To test your filesystem support, install the 'attr' package and run
174 the following 4 commands as root::
175
176   # touch test.txt
177   # setfattr -n user.test -v test test.txt
178   # setfattr -n security.test -v test2 test.txt
179   # getfattr -d test.txt
180   # getfattr -n security.test -d test.txt
181
182 You should see output like this::
183
184   # file: test.txt
185   user.test="test"
186   
187   # file: test.txt
188   security.test="test2"
189
190 If you get any "Operation not supported" errors then it means your
191 kernel is not configured correctly, or your filesystem is not mounted
192 with the right options.
193
194 If you get any "Operation not permitted" errors then it probably means
195 you didn't try the test as root.
196
197 ..
198         vim: ft=rest