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