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 There are 2 methods of doing this:
  20
  21   method 1:  "rsync -avz samba.org::ftp/unpacked/samba_4_0_test/ samba4"
  22
  23   method 2:  "git clone git://git.samba.org/samba.git samba4; cd samba4; git checkout v4-0-test; cd .."
  24
  25 both methods will create a directory called "samba4" in the current
  26 directory. If you don't have rsync or git then install one of them.
  27
  28 Since only released versions of Samba contain a pregenerated configure script,
  29 you will have to generate it by hand::
  30
  31  $ cd samba4/source
  32  $ ./autogen.sh
  33
  34 Note that the above rsync command will give you a checked out git
  35 repository. So if you also have git you can update it to the latest
  36 version at some future date using::
  37
  38   $ cd samba4
  39   $ git pull origin v4-0-test
  40
  41 Step 2: compile Samba4
  42 ----------------------
  43
  44 Recommended optional development libraries:
  45 - acl and xattr development libraries
  46 - gnutls
  47 - readline
  48
  49 Run this::
  50
  51   $ cd samba4/source
  52   $ ./configure
  53   $ make proto all
  54
  55 If you have gcc 3.4 or newer, then substitute "pch" for "proto" to
  56 greatly speed up the compile process (about 5x faster).
  57
  58 Step 3: install Samba4
  59 ----------------------
  60
  61 Run this as a user who have permission to write to the install
  62 directory (defaults to /usr/local/samba). Use --prefix option to
  63 configure above to change this.
  64
  65 ::
  66
  67   # make install
  68
  69
  70 Step 4: provision Samba4
  71 ------------------------
  72
  73 The "provision" step sets up a basic user database. Make sure your smbscript
  74 binary is installed in a directory listed in your PATH environment variable.
  75 It is presumed it's available just like any other commands from your shell.
  76 Must be run as a user with permission to write to the install directory.
  77
  78 ::
  79
  80   # cd source
  81   # bin/smbpython ./setup/provision --realm=YOUR.REALM --domain=YOURDOM \
  82   #  --adminpass=SOMEPASSWORD --server-role='domain controller'
  83
  84 REMINDER: Use the path to smbpython, as the provision command
  85           will not work with the system python.
  86
  87 'YOURDOM' is the NT4 style domain name. 'YOUR.REALM' is your kerberos
  88 realm, which is typically your DNS domain name.
  89
  90 Step 5: Create a simple smb.conf
  91 --------------------------------
  92
  93 The provisioning will create a very simple smb.conf with no shares by
  94 default. You will need to update it to add at least one share. For
  95 example::
  96
  97   [test]
  98         path = /data/test
  99         read only = no
 100
 101
 102 Step 6: starting Samba4
 103 -----------------------
 104
 105 The simplest is to just run "smbd", but as a developer you may find
 106 the following more useful::
 107
 108    # smbd -i -M single
 109
 110 that means "start smbd without messages in stdout, and running a
 111 single process. That mode of operation makes debugging smbd with gdb
 112 particularly easy.
 113
 114 Note that now it is no longer necessary to have an instance of nmbd
 115 from Samba 3 running.  If you are running any smbd or nmbd processes
 116 they need to be stopped before starting smbd from Samba 4.
 117
 118 Make sure you put the bin and sbin directories from your new install
 119 in your $PATH. Make sure you run the right version!
 120
 121
 122 Step 7: testing Samba4
 123 ----------------------
 124
 125 try these commands::
 126
 127   $ smbclient //localhost/test -Uadministrator%SOMEPASSWORD
 128
 129 or::
 130
 131   $ ./script/tests/test_posix.sh //localhost/test administrator SOMEPASSWORD
 132
 133
 134 NOTE about filesystem support
 135 -----------------------------
 136
 137 To use the advanced features of Samba4 you need a filesystem that
 138 supports both the "user" and "system" xattr namespaces.
 139
 140 If you run Linux with a 2.6 kernel and ext3 this means you need to
 141 include the option "user_xattr" in your /etc/fstab. For example::
 142
 143    /dev/hda3            /home                   ext3    user_xattr     1 1
 144
 145 You also need to compile your kernel with the XATTR and SECURITY
 146 options for your filesystem. For ext3 that means you need::
 147
 148    CONFIG_EXT3_FS_XATTR=y
 149    CONFIG_EXT3_FS_SECURITY=y
 150
 151 If you are running a Linux 2.6 kernel with CONFIG_IKCONFIG_PROC
 152 defined you can check this with the following command::
 153
 154    $ zgrep CONFIG_EXT3_FS /proc/config.gz
 155
 156 If you don't have a filesystem with xattr support, then you can
 157 simulate it by using the option::
 158
 159    posix:eadb = /usr/local/samba/eadb.tdb
 160
 161 that will place all extra file attributes (NT ACLs, DOS EAs, streams
 162 etc), in that tdb. It is not efficient, and doesn't scale well, but at
 163 least it gives you a choice when you don't have a modern filesystem.
 164
 165 Testing your filesystem
 166 -----------------------
 167
 168 To test your filesystem support, install the 'attr' package and run
 169 the following 4 commands as root::
 170
 171   # touch test.txt
 172   # setfattr -n user.test -v test test.txt
 173   # setfattr -n security.test -v test2 test.txt
 174   # getfattr -d test.txt
 175   # getfattr -n security.test -d test.txt
 176
 177 You should see output like this::
 178
 179   # file: test.txt
 180   user.test="test"
 181
 182   # file: test.txt
 183   security.test="test2"
 184
 185 If you get any "Operation not supported" errors then it means your
 186 kernel is not configured correctly, or your filesystem is not mounted
 187 with the right options.
 188
 189 If you get any "Operation not permitted" errors then it probably means
 190 you didn't try the test as root.
 191
 192 ..
 193         vim: ft=rest