examples/LDAP/smbldap-tools/README

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