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