syncing files
[samba.git] / examples / LDAP / smbldap-tools / README
1 Latest version may be found at http://samba.idealx.org/
2
3
4 What those tools are for?
5 =-=-=-=-=-=-=-=-=-=-=-=-=
6
7 A collection of scripts, «over» user{add,del,mod} and group{add,del,mod}
8 system tools to manipulate users and groups stored in LDAP directory,
9 for DEN system like SAMBA-LDAP and pam/nss_ldap systems.
10
11 Additionnaly, some scripts are designed to ease your migration from
12 a Windows NT 4.0 PDC Server to a Samba-LDAP PDC Server (Killer?;-):
13 smbldap-populate, smbldap-migrate-groups, smbldap-migrate-accounts.
14
15 They are currently used with Samba 2.2.4, therefore you may (will) have
16 to make some fixes for Samba TNG and Samba 3.0. Hint: contribs welcome :)
17
18 In the future, some other function may come (like backup and restore,
19 Novell migration tools, samba system activity report, dealing with
20 mail functions, compliance to RFC2307...): consult TODO.
21
22
23 What do SMBLDAP-TOOLS provide?
24 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
25 Those tools provide the following functions :
26  . populate LDAP database with a basic LDIF
27  . add a user or group
28  . delete a user or group
29  . modify all users or groups data (all attributes types stored in
30    posixAccount and sambaAccount object class)
31 Taking care of :
32  . staying compatible with all standard system tools options
33    (user/group{add,del,mod})
34  . be extensible for future developments
35    (manipulation of shadow account options, for example)
36  . error management, in the way system tools do
37 Constraints :
38  . usage of PERL (portability)
39  . all options must be placed in an external configuration file
40  . english localization
41
42 The current release uses the "mkntpwd" program, in mkntpwd.tar.gz
43 in the current directory. It comes from
44 http://www.demog.berkeley.edu/~aperrin/tips/src/mkntpwd.tar.gz
45 It allows to not use smbpasswd (if $with_smbpasswd == 0 in smbldap_conf.pm)
46
47 What do SMBLDAP-TOOLS deliver?
48 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
49 Contents :
50  . scripts (see FILES)
51  . user documentation in pod format, included in the sources
52    (or just use the -? option)
53
54 These tools aim at delivering the same functionality as the corresponding
55 system tools. However they may not be all implemented yet.
56 Current limitations :
57  . no shadow support
58  . cannot change uid with usermod
59  . no UTF-8 support (thus ASCII-7 only)
60
61
62 How to generate documentation?
63 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
64 Just issue the following command:
65  perldoc name_of_script.pl (ex: perldoc smbldap-useradd.pl)
66
67 Where can I find the latest release of those scripts?
68 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
69
70 Just fire any web browser to http://samba.IDEALX.org/
71 and/or contact samba@IDEALX.org
72
73 Additionnaly, you will find an useful Webmin module
74 at http://webmin.IDEALX.org/ if interested in a graphical 
75 user interface to manager user and groups accounts via Webmin
76 for your Samba+LDAP PDC.
77
78 Let us know if these tools helped you, or if we should enhance
79 them with some functions you want them to support.
80
81 Sincerly,
82         LEM
83
84 # - The End