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
  33 Step 2: compile Samba4
  34 ----------------------
  35
  36 Run this:
  37
  38   cd samba4/source
  39   ./autogen.sh
  40   ./configure.developer -C
  41   make
  42
  43 If you have gcc 3.4 or newer, then run "make pch" before "make" to
  44 greatly speed up the compile process (about 5x faster).
  45
  46
  47 Step 3: install Samba4
  48 ----------------------
  49
  50 Run this as a user who have permission to write to the install
  51 directory (defaults to /usr/local/samba). Use --prefix option to
  52 configure above to change this.
  53
  54   make install
  55
  56
  57 Step 4: provision Samba4
  58 ------------------------
  59
  60 The "provision" step sets up a basic user database.
  61
  62   cd source
  63   ./script/provision.pl --realm=YOUR.REALM --domain=YOURDOM --adminpass=SOMEPASSWORD
  64
  65 This will create a number of new 'ldb' database files in a directory
  66 newdb.XXX. You need to move these to the "private" subdirectory of
  67 your install. For example:
  68
  69   mv newdb.123/*.ldb /usr/local/samba/private/
  70
  71
  72 Step 5: Create a simple smb.conf
  73 --------------------------------
  74
  75 You need to create a smb.conf file in the lib/ directory of your
  76 install. The default is /usr/local/samba/lib/smb.conf. A minimal
  77 smb.conf would be:
  78
  79   workgroup = YOURDOM
  80
  81   [test]
  82         path = /data/test
  83         read only = no
  84
  85 The workgroup must exactly match the --domain argument you gave to provision.pl
  86
  87
  88 Step 6: starting Samba4
  89 -----------------------
  90
  91 The simplest is to just run "smbd", but as a developer you may find
  92 the following more useful:
  93
  94    smbd -i -M single -d3
  95
  96 that means "start smbd without messages in stdout, and running a
  97 single process, with level 3 debugging". That mode of operation makes
  98 debugging smbd with gdb particularly easy.
  99
 100 Make sure you put the bin and sbin directories from your new install
 101 in your $PATH. Make sure you run the right version!
 102
 103
 104 Step 7: testing Samba4
 105 ----------------------
 106
 107 try these commands:
 108
 109       smbclient //localhost/test -Uadministrator%SOMEPASSWORD
 110     or
 111      ./script/tests/test_posix.sh //localhost/test administrator SOMEPASSWORD
 112
 113
 114 NOTE about filesystem support
 115 -----------------------------
 116
 117 To use the advanced features of Samba4 you need a filesystem that
 118 supports both the "user" and "system" xattr namespaces.
 119
 120 If you run Linux with a 2.6 kernel and ext3 this means you need to
 121 include the option "user_xattr" in your /etc/fstab. For example:
 122
 123 /dev/hda3               /home                   ext3    user_xattr     1 1
 124
 125 You also need to compile your kernel with the XATTR and SECURITY
 126 options for your filesystem. For ext3 that means you need:
 127
 128    CONFIG_EXT3_FS_XATTR=y
 129    CONFIG_EXT3_FS_SECURITY=y
 130
 131 If you don't have a filesystem with xattr support, then you can
 132 simulate it by using the option:
 133
 134    posix:eadb = /usr/local/samba/eadb.tdb
 135
 136 that will place all extra file attributes (NT ACLs, DOS EAs, streams
 137 etc), in that tdb. It is not efficient, and doesn't scale well, but at
 138 least it gives you a choice when you don't have a modern filesystem.
 139
 140 Testing your filesystem
 141 -----------------------
 142
 143 To test your filesystem support, install the 'attr' package and run
 144 the following 4 commands as root:
 145
 146   touch test.txt
 147   setfattr -n user.test -v test test.txt
 148   setfattr -n security.test -v test2 test.txt
 149   getfattr -d test.txt
 150   getfattr -n security.test -d test.txt
 151
 152 You should see output like this:
 153
 154   # file: test.txt
 155   user.test="test"
 156
 157   # file: test.txt
 158   security.test="test2"
 159
 160 If you get any "Operation not supported" errors then it means your
 161 kernel is not configured correctly, or your filesystem is not mounted
 162 with the right options.
 163
 164 If you get any "Operation not permitted" errors then it probably means
 165 you didn't try the test as root.