r8647: no diffrences between the heimdal and no heimdal case when building
[jelmer/samba4-debian.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. 
60
61   $ cd source
62   $ ./setup/provision --realm=YOUR.REALM --domain=YOURDOM --adminpass=SOMEPASSWORD
63
64 Step 5: Create a simple smb.conf
65 --------------------------------
66
67 The provisioning will create a very simple smb.conf with no shares by
68 default. You will need to update it to add at least one share. For
69 example:
70
71   [test]
72         path = /data/test
73         read only = no
74
75
76 Step 6: starting Samba4
77 -----------------------
78
79 The simplest is to just run "smbd", but as a developer you may find
80 the following more useful:
81
82    # smbd -i -M single
83
84 that means "start smbd without messages in stdout, and running a
85 single process. That mode of operation makes debugging smbd with gdb
86 particularly easy.
87
88 Note that now it is no longer necessary to have an instance of nmbd
89 from Samba 3 running.  If you are running any smbd or nmbd processes
90 they need to be stopped before starting smbd from Samba 4.
91
92 Make sure you put the bin and sbin directories from your new install
93 in your $PATH. Make sure you run the right version!
94
95
96 Step 7: testing Samba4
97 ----------------------
98
99 try these commands:
100
101      $ smbclient //localhost/test -Uadministrator%SOMEPASSWORD
102     or
103      $ ./script/tests/test_posix.sh //localhost/test administrator SOMEPASSWORD
104
105
106 NOTE about filesystem support
107 -----------------------------
108
109 To use the advanced features of Samba4 you need a filesystem that
110 supports both the "user" and "system" xattr namespaces.
111
112 If you run Linux with a 2.6 kernel and ext3 this means you need to
113 include the option "user_xattr" in your /etc/fstab. For example:
114
115 /dev/hda3               /home                   ext3    user_xattr     1 1
116
117 You also need to compile your kernel with the XATTR and SECURITY
118 options for your filesystem. For ext3 that means you need:
119
120    CONFIG_EXT3_FS_XATTR=y
121    CONFIG_EXT3_FS_SECURITY=y
122
123 If you are running a Linux 2.6 kernel with CONFIG_IKCONFIG_PROC
124 defined you can check this with the following command:
125
126    $ zgrep CONFIG_EXT3_FS /proc/config.gz
127
128 If you don't have a filesystem with xattr support, then you can
129 simulate it by using the option:
130
131    posix:eadb = /usr/local/samba/eadb.tdb
132
133 that will place all extra file attributes (NT ACLs, DOS EAs, streams
134 etc), in that tdb. It is not efficient, and doesn't scale well, but at
135 least it gives you a choice when you don't have a modern filesystem.
136
137 Testing your filesystem
138 -----------------------
139
140 To test your filesystem support, install the 'attr' package and run
141 the following 4 commands as root:
142
143   # touch test.txt
144   # setfattr -n user.test -v test test.txt
145   # setfattr -n security.test -v test2 test.txt
146   # getfattr -d test.txt
147   # getfattr -n security.test -d test.txt
148
149 You should see output like this:
150
151   # file: test.txt
152   user.test="test"
153
154   # file: test.txt
155   security.test="test2"
156
157 If you get any "Operation not supported" errors then it means your
158 kernel is not configured correctly, or your filesystem is not mounted
159 with the right options.
160
161 If you get any "Operation not permitted" errors then it probably means
162 you didn't try the test as root.
163
164