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