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