howto4.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 -b v4-0-test origin/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
  63 Step 2bis: recompile Samba4
  64 ---------------------------
  65
  66 This only applies for those who are recompiling Samba4 after updating the code
  67 (using "rsync" or "git").
  68
  69 Due to some imperfections in our actual build system (hope that this changes
  70 soon) it is recommended to perform this after the source upgrade:
  71
  72   $ cd samba4/source
  73   $ make clean
  74   $ ./autogen.sh
  75   $ ./configure
  76   $ make idl_full
  77   $ make
  78
  79 Not all the steps are needed every time but doing so makes sure that you won't
  80 have old compiled objects standing in the way and cause malfunctions.
  81 It also makes sure that changes in the IDL files are correctly catched up.
  82
  83 Step 3: install Samba4
  84 ----------------------
  85
  86 Run this as a user who have permission to write to the install
  87 directory (defaults to /usr/local/samba). Use --prefix option to
  88 configure above to change this.
  89
  90 ::
  91
  92   # make install
  93
  94 Step 4: provision Samba4
  95 ------------------------
  96
  97 The "provision" step sets up a basic user database. Be warned that this
  98 removes all preexisting database data (if any)!
  99
 100 It must be run as a user with permission to write to the install directory
 101 (typically "root").
 102
 103 ::
 104
 105   # cd source
 106   # ./setup/provision --realm=YOUR.REALM --domain=YOURDOM \
 107   #  --adminpass=SOMEPASSWORD --server-role='domain controller'
 108
 109 'YOURDOM' is the NT4 style domain name. 'YOUR.REALM' is your kerberos
 110 realm, which is typically your DNS domain name.
 111
 112 If you provisioned a more recent Samba4 system already you should be able to
 113 use the procedures shown in "upgrading-samba4.txt" to upgrade it and keep all
 114 data.
 115
 116 When you are using Samba3 at the moment you could try the experimental script
 117 "upgrade_from_s3" under the "setup" directory of the source
 118 distribution (it isn't included in binary distributions yet).
 119
 120 Step 5: Create a simple smb.conf
 121 --------------------------------
 122
 123 The provisioning will create a very simple smb.conf with no shares by
 124 default. You will need to update it to add at least one share. For
 125 example::
 126
 127   [test]
 128         path = /data/test
 129         read only = no
 130
 131 Step 6: starting Samba4
 132 -----------------------
 133
 134 The simplest is to just run "samba", but as a developer you may find
 135 the following more useful::
 136
 137    # samba -i -M single
 138
 139 that means "start samba without messages in stdout, and running a
 140 single process. That mode of operation makes debugging samba with gdb
 141 particularly easy.
 142
 143 Note that now it is no longer necessary to have an instance of nmbd
 144 from Samba 3 running.  If you are running any smbd or nmbd processes
 145 they need to be stopped before starting samba from Samba 4.
 146
 147 Make sure you put the bin and sbin directories from your new install
 148 in your $PATH. Make sure you run the right version!
 149
 150 Step 7: testing Samba4
 151 ----------------------
 152
 153 try this command::
 154
 155   $ smbclient //localhost/test -Uadministrator%SOMEPASSWORD
 156
 157
 158 NOTE about filesystem support
 159 -----------------------------
 160
 161 To use the advanced features of Samba4 you need a filesystem that
 162 supports both the "user" and "system" xattr namespaces.
 163
 164 If you run Linux with a 2.6 kernel and ext3 this means you need to
 165 include the option "user_xattr" in your /etc/fstab. For example::
 166
 167    /dev/hda3            /home                   ext3    user_xattr     1 1
 168
 169 You also need to compile your kernel with the XATTR and SECURITY
 170 options for your filesystem. For ext3 that means you need::
 171
 172    CONFIG_EXT3_FS_XATTR=y
 173    CONFIG_EXT3_FS_SECURITY=y
 174
 175 If you are running a Linux 2.6 kernel with CONFIG_IKCONFIG_PROC
 176 defined you can check this with the following command::
 177
 178    $ zgrep CONFIG_EXT3_FS /proc/config.gz
 179
 180 If you don't have a filesystem with xattr support, then you can
 181 simulate it by using the option::
 182
 183    posix:eadb = /usr/local/samba/eadb.tdb
 184
 185 that will place all extra file attributes (NT ACLs, DOS EAs, streams
 186 etc), in that tdb. It is not efficient, and doesn't scale well, but at
 187 least it gives you a choice when you don't have a modern filesystem.
 188
 189 Testing your filesystem
 190 -----------------------
 191
 192 To test your filesystem support, install the 'attr' package and run
 193 the following 4 commands as root::
 194
 195   # touch test.txt
 196   # setfattr -n user.test -v test test.txt
 197   # setfattr -n security.test -v test2 test.txt
 198   # getfattr -d test.txt
 199   # getfattr -n security.test -d test.txt
 200
 201 You should see output like this::
 202
 203   # file: test.txt
 204   user.test="test"
 205
 206   # file: test.txt
 207   security.test="test2"
 208
 209 If you get any "Operation not supported" errors then it means your
 210 kernel is not configured correctly, or your filesystem is not mounted
 211 with the right options.
 212
 213 If you get any "Operation not permitted" errors then it probably means
 214 you didn't try the test as root.
 215
 216 ..
 217         vim: ft=rest