r9805: Add 'data' property to param EJS object
[ira/wip.git] / howto.txt
1 Samba4 developer howto
2 ----------------------
3
4 tridge@samba.org, December 2004
5
6
7 This is a very basic document on how to setup a simple Samba4
8 server. This is aimed at developers who are already familiar with
9 Samba3 and wish to participate in Samba4 development. This is not
10 aimed at production use of Samba4.
11
12
13 Step 1: download Samba4
14 -----------------------
15
16 There are 2 methods of doing this:
17
18   method 1:  "rsync -avz samba.org::ftp/unpacked/samba4 ."
19
20   method 2:  "svn co svn://svnanon.samba.org/samba/branches/SAMBA_4_0 samba4"
21
22 both methods will create a directory called "samba4" in the current
23 directory. If you don't have rsync or svn then install one of them. 
24
25 Note that the above rsync command will give you a checked out svn
26 repository. So if you also have svn you can update it to the latest
27 version at some future date using:
28
29   $ cd samba4
30   $ svn up
31
32 Step 2: compile Samba4
33 ----------------------
34
35 Run this:
36
37   $ cd samba4/source
38   $ ./autogen.sh
39   $ ./configure.developer
40   $ make proto all
41
42 If you have gcc 3.4 or newer, then substitue "pch" for "proto" to
43 greatly speed up the compile process (about 5x faster).
44
45
46 Step 3: install Samba4
47 ----------------------
48
49 Run this as a user who have permission to write to the install
50 directory (defaults to /usr/local/samba). Use --prefix option to
51 configure above to change this.
52  
53   # make install
54
55
56 Step 4: provision Samba4
57 ------------------------
58
59 The "provision" step sets up a basic user database. Make sure your smbscript
60 binary is installed in a directory listed in your PATH environment variable.
61 It is presumed it's available just like any other commands from your shell.
62
63   $ cd source
64   $ ./setup/provision --realm=YOUR.REALM --domain=YOURDOM --adminpass=SOMEPASSWORD
65
66 Step 5: Create a simple smb.conf
67 --------------------------------
68
69 The provisioning will create a very simple smb.conf with no shares by
70 default. You will need to update it to add at least one share. For
71 example:
72
73   [test]
74         path = /data/test
75         read only = no
76
77
78 Step 6: starting Samba4
79 -----------------------
80
81 The simplest is to just run "smbd", but as a developer you may find
82 the following more useful:
83
84    # smbd -i -M single
85
86 that means "start smbd without messages in stdout, and running a
87 single process. That mode of operation makes debugging smbd with gdb
88 particularly easy.
89
90 Note that now it is no longer necessary to have an instance of nmbd
91 from Samba 3 running.  If you are running any smbd or nmbd processes
92 they need to be stopped before starting smbd from Samba 4.
93
94 Make sure you put the bin and sbin directories from your new install
95 in your $PATH. Make sure you run the right version!
96
97
98 Step 7: testing Samba4
99 ----------------------
100
101 try these commands:
102
103      $ smbclient //localhost/test -Uadministrator%SOMEPASSWORD
104     or
105      $ ./script/tests/test_posix.sh //localhost/test administrator SOMEPASSWORD
106
107
108 NOTE about filesystem support
109 -----------------------------
110
111 To use the advanced features of Samba4 you need a filesystem that
112 supports both the "user" and "system" xattr namespaces.
113
114 If you run Linux with a 2.6 kernel and ext3 this means you need to
115 include the option "user_xattr" in your /etc/fstab. For example:
116
117 /dev/hda3               /home                   ext3    user_xattr     1 1
118
119 You also need to compile your kernel with the XATTR and SECURITY
120 options for your filesystem. For ext3 that means you need:
121
122    CONFIG_EXT3_FS_XATTR=y
123    CONFIG_EXT3_FS_SECURITY=y
124
125 If you are running a Linux 2.6 kernel with CONFIG_IKCONFIG_PROC
126 defined you can check this with the following command:
127
128    $ zgrep CONFIG_EXT3_FS /proc/config.gz
129
130 If you don't have a filesystem with xattr support, then you can
131 simulate it by using the option:
132
133    posix:eadb = /usr/local/samba/eadb.tdb
134
135 that will place all extra file attributes (NT ACLs, DOS EAs, streams
136 etc), in that tdb. It is not efficient, and doesn't scale well, but at
137 least it gives you a choice when you don't have a modern filesystem.
138
139 Testing your filesystem
140 -----------------------
141
142 To test your filesystem support, install the 'attr' package and run
143 the following 4 commands as root:
144
145   # touch test.txt
146   # setfattr -n user.test -v test test.txt
147   # setfattr -n security.test -v test2 test.txt
148   # getfattr -d test.txt
149   # getfattr -n security.test -d test.txt
150
151 You should see output like this:
152
153   # file: test.txt
154   user.test="test"
155
156   # file: test.txt
157   security.test="test2"
158
159 If you get any "Operation not supported" errors then it means your
160 kernel is not configured correctly, or your filesystem is not mounted
161 with the right options.
162
163 If you get any "Operation not permitted" errors then it probably means
164 you didn't try the test as root.
165
166