Add python bindings for unixinfo.
[jelmer/samba4-debian.git] / howto.txt
index 3991781268150e6b3257b77d3543d04e4cf43ad2..d128baa5bd47ca483ab3262b2ad1a2ce573cc259 100644 (file)
--- a/howto.txt
+++ b/howto.txt
@@ -1,39 +1,49 @@
 Samba4 developer howto
 Samba4 developer howto
-----------------------
+======================
 
 tridge@samba.org, December 2004
 
 
 tridge@samba.org, December 2004
 
+A more up to date version of this howto can be found in the wiki 
+at http://wiki.samba.org/index.php/Samba4/HOWTO.
 
 This is a very basic document on how to setup a simple Samba4
 server. This is aimed at developers who are already familiar with
 Samba3 and wish to participate in Samba4 development. This is not
 aimed at production use of Samba4.
 
 
 This is a very basic document on how to setup a simple Samba4
 server. This is aimed at developers who are already familiar with
 Samba3 and wish to participate in Samba4 development. This is not
 aimed at production use of Samba4.
 
+.. contents::
 
 Step 1: download Samba4
 -----------------------
 
 
 Step 1: download Samba4
 -----------------------
 
+If you have downloaded the Samba4 code via a tarball released from the
+samba.org website, Step 1 has already been completed for you.  For testing
+with the version released in the tarball, you may continue on to Step 2.  Note
+that the references below to the top-level directory named "samba4" will
+instead be based on the name of the tarball downloaded (e.g.
+"samba-4.0.0alpha3" for the tarball samba-4.0.0alpha3.tar.gz).
+
 There are 2 methods of doing this:
 
 There are 2 methods of doing this:
 
-  method 1:  "rsync -avz samba.org::ftp/unpacked/samba4 ."
+  method 1:  "rsync -avz samba.org::ftp/unpacked/samba_4_0_test/ samba4"
 
 
-  method 2:  "svn co svn://svnanon.samba.org/samba/branches/SAMBA_4_0 samba4"
+  method 2:  "git clone git://git.samba.org/samba.git samba4; cd samba4; git checkout v4-0-test; cd .."
 
 both methods will create a directory called "samba4" in the current
 
 both methods will create a directory called "samba4" in the current
-directory. If you don't have rsync or svn then install one of them. 
+directory. If you don't have rsync or git then install one of them. 
 
 Since only released versions of Samba contain a pregenerated configure script, 
 
 Since only released versions of Samba contain a pregenerated configure script, 
-you will have to generate it by hand:
+you will have to generate it by hand::
 
  $ cd samba4/source
  $ ./autogen.sh
 
 
  $ cd samba4/source
  $ ./autogen.sh
 
-Note that the above rsync command will give you a checked out svn
-repository. So if you also have svn you can update it to the latest
-version at some future date using:
+Note that the above rsync command will give you a checked out git
+repository. So if you also have git you can update it to the latest
+version at some future date using::
 
   $ cd samba4
 
   $ cd samba4
-  $ svn up
+  $ git pull origin v4-0-test
 
 Step 2: compile Samba4
 ----------------------
 
 Step 2: compile Samba4
 ----------------------
@@ -43,14 +53,11 @@ Recommended optional development libraries:
 - gnutls
 - readline
 
 - gnutls
 - readline
 
-Run this:
+Run this::
 
   $ cd samba4/source
   $ ./configure
 
   $ cd samba4/source
   $ ./configure
-  $ make proto all
-
-If you have gcc 3.4 or newer, then substitute "pch" for "proto" to
-greatly speed up the compile process (about 5x faster).
+  $ make
 
 Step 3: install Samba4
 ----------------------
 
 Step 3: install Samba4
 ----------------------
@@ -58,6 +65,8 @@ Step 3: install Samba4
 Run this as a user who have permission to write to the install
 directory (defaults to /usr/local/samba). Use --prefix option to
 configure above to change this.
 Run this as a user who have permission to write to the install
 directory (defaults to /usr/local/samba). Use --prefix option to
 configure above to change this.
+
+::
  
   # make install
 
  
   # make install
 
@@ -65,17 +74,17 @@ configure above to change this.
 Step 4: provision Samba4
 ------------------------
 
 Step 4: provision Samba4
 ------------------------
 
-The "provision" step sets up a basic user database. Make sure your smbscript
-binary is installed in a directory listed in your PATH environment variable.
-It is presumed it's available just like any other commands from your shell.
+The "provision" step sets up a basic user database. 
 Must be run as a user with permission to write to the install directory.
 
 Must be run as a user with permission to write to the install directory.
 
+::
+
   # cd source
   # cd source
-  # ./setup/provision --realm=YOUR.REALM --domain=YOURDOM --adminpass=SOMEPASSWORD
+  # bin/smbpython ./setup/provision --realm=YOUR.REALM --domain=YOURDOM \
+  #  --adminpass=SOMEPASSWORD --server-role='domain controller'
 
 
-REMINDER: Add the "bin" directory of the path you installed to
-          (e.g. /usr/local/samba/bin) to your path, or the provision command
-          will not work.
+REMINDER: Use the path to smbpython, as the provision command
+          will not work with the system python.
 
 'YOURDOM' is the NT4 style domain name. 'YOUR.REALM' is your kerberos
 realm, which is typically your DNS domain name.
 
 'YOURDOM' is the NT4 style domain name. 'YOUR.REALM' is your kerberos
 realm, which is typically your DNS domain name.
@@ -85,7 +94,7 @@ Step 5: Create a simple smb.conf
 
 The provisioning will create a very simple smb.conf with no shares by
 default. You will need to update it to add at least one share. For
 
 The provisioning will create a very simple smb.conf with no shares by
 default. You will need to update it to add at least one share. For
-example:
+example::
 
   [test]
        path = /data/test
 
   [test]
        path = /data/test
@@ -96,7 +105,7 @@ Step 6: starting Samba4
 -----------------------
 
 The simplest is to just run "smbd", but as a developer you may find
 -----------------------
 
 The simplest is to just run "smbd", but as a developer you may find
-the following more useful:
+the following more useful::
 
    # smbd -i -M single
 
 
    # smbd -i -M single
 
@@ -115,11 +124,9 @@ in your $PATH. Make sure you run the right version!
 Step 7: testing Samba4
 ----------------------
 
 Step 7: testing Samba4
 ----------------------
 
-try these commands:
+try this command::
 
 
-     $ smbclient //localhost/test -Uadministrator%SOMEPASSWORD
-    or
-     $ ./script/tests/test_posix.sh //localhost/test administrator SOMEPASSWORD
+  $ smbclient //localhost/test -Uadministrator%SOMEPASSWORD
 
 
 NOTE about filesystem support
 
 
 NOTE about filesystem support
@@ -129,23 +136,23 @@ To use the advanced features of Samba4 you need a filesystem that
 supports both the "user" and "system" xattr namespaces.
 
 If you run Linux with a 2.6 kernel and ext3 this means you need to
 supports both the "user" and "system" xattr namespaces.
 
 If you run Linux with a 2.6 kernel and ext3 this means you need to
-include the option "user_xattr" in your /etc/fstab. For example:
+include the option "user_xattr" in your /etc/fstab. For example::
 
 
-/dev/hda3              /home                   ext3    user_xattr     1 1
+   /dev/hda3           /home                   ext3    user_xattr     1 1
 
 You also need to compile your kernel with the XATTR and SECURITY
 
 You also need to compile your kernel with the XATTR and SECURITY
-options for your filesystem. For ext3 that means you need:
+options for your filesystem. For ext3 that means you need::
 
    CONFIG_EXT3_FS_XATTR=y
    CONFIG_EXT3_FS_SECURITY=y
 
 If you are running a Linux 2.6 kernel with CONFIG_IKCONFIG_PROC
 
    CONFIG_EXT3_FS_XATTR=y
    CONFIG_EXT3_FS_SECURITY=y
 
 If you are running a Linux 2.6 kernel with CONFIG_IKCONFIG_PROC
-defined you can check this with the following command:
+defined you can check this with the following command::
 
    $ zgrep CONFIG_EXT3_FS /proc/config.gz
 
 If you don't have a filesystem with xattr support, then you can
 
    $ zgrep CONFIG_EXT3_FS /proc/config.gz
 
 If you don't have a filesystem with xattr support, then you can
-simulate it by using the option:
+simulate it by using the option::
 
    posix:eadb = /usr/local/samba/eadb.tdb
 
 
    posix:eadb = /usr/local/samba/eadb.tdb
 
@@ -157,7 +164,7 @@ Testing your filesystem
 -----------------------
 
 To test your filesystem support, install the 'attr' package and run
 -----------------------
 
 To test your filesystem support, install the 'attr' package and run
-the following 4 commands as root:
+the following 4 commands as root::
 
   # touch test.txt
   # setfattr -n user.test -v test test.txt
 
   # touch test.txt
   # setfattr -n user.test -v test test.txt
@@ -165,11 +172,11 @@ the following 4 commands as root:
   # getfattr -d test.txt
   # getfattr -n security.test -d test.txt
 
   # getfattr -d test.txt
   # getfattr -n security.test -d test.txt
 
-You should see output like this:
+You should see output like this::
 
   # file: test.txt
   user.test="test"
 
   # file: test.txt
   user.test="test"
-
+  
   # file: test.txt
   security.test="test2"
 
   # file: test.txt
   security.test="test2"
 
@@ -180,4 +187,5 @@ with the right options.
 If you get any "Operation not permitted" errors then it probably means
 you didn't try the test as root.
 
 If you get any "Operation not permitted" errors then it probably means
 you didn't try the test as root.
 
-
+..
+       vim: ft=rest