s3:test: rename samba3.blackbox.net_s3_registry -> samba3.blackbox.net.local.registry
[Samba.git] / source3 / pam_smbpass / INSTALL
blobae2ba02bbbcca9e24cf42e0ac68368b0c7609ed6
2 Because pam_smbpass is derived from the Samba smbpasswd utility, recent
3 versions of pam_smbpass require a copy of the Samba source code to be
4 available on the build system.  Version 0.7.5 has been tested against
5 Samba 2.2.0-alpha3, and this is the recommended version of Samba to use
6 for building pam_smbpass.  This only affects /building/ pam_smbpass; you
7 can still run any version of the Samba server that you want, although
8 clearly it saves some disk space to have only one copy of the source
9 code on your system (Samba 2.2.0-alpha3 takes roughly 32MB of disk space
10 to build pam_smbpass).
12 Version 0.7.5 features a new build system to make it easier to build
13 pam_smbpass.
16 Using the new build system
17 ==========================
19 If you don't have a copy of the Samba source code on your machine, and you
20 don't have a preferred Samba version (or mirror site), you can build
21 pam_smbpass by just typing 'make'.
23 If you want to use a version other than 2.2.0-alpha3, or you want to
24 download the source code from a faster Samba mirror (see
25 <http://us1.samba.org/samba/> for a list of mirror sites), please download
26 the source code and unpack it before running make.  The build scripts will
27 attempt to autodetect your Samba source directory, and if it can't be
28 found automatically, you will be given the opportunity to specify an
29 alternate directory for the Samba sources.
31 Feedback is welcome if you try (or succeed!) to build pam_smbpass with
32 other versions of Samba.
35 Options to 'make'
36 =================
38 By default, pam_smbpass will configure the Samba build tree with the
39 options
41     --with-fhs --with-privatedir=/etc --with-configdir=/etc
43 This will configure pam_smbpass to look for the smbpasswd file as
44 /etc/smbpasswd (or /etc/smbpasswd.tdb), and the smb.conf file as
45 /etc/smb.conf.  You can override these options by setting CONFIGOPTS when
46 calling make.  E.g., if you have your smb.conf file in /usr/etc and your
47 smbpasswd file in /usr/etc/private, you might run
49     make CONFIGOPTS="--with-privatedir=/usr/etc/private --with-configdir=/usr/etc"
51 For a complete list of available configuration options, see
52 './samba/configure --help'
55 Installing the module
56 =====================
58 If all goes well in the build process, the file pam_smbpass.so will be
59 created in the current directory.  Simply install the module into your
60 system's PAM module directory:
62         install -m 755 -s bin/pam_smbpass.so /lib/security
64 and you're all set.