home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / share / doc / adduser / examples / README < prev   
Encoding:
Text File  |  2006-07-10  |  5.5 KB  |  139 lines
  1. **************************************************************************
  2. *                                                                        *
  3. *                   ADDUSER Local System Additions v4.6                  *
  4. *                 Copyright (C) 1999-2004, John Zaitseff                 *
  5. *                                                                        *
  6. **************************************************************************
  7.  
  8. Welcome to the ADDUSER Local System Additions program!  This program, once
  9. installed as /usr/local/sbin/adduser.local,  works in conjunction with the
  10. Debian adduser(8) command to extend the creation of your user accounts.
  11.  
  12. As a system administrator, you are often faced with a long list of "things
  13. to  do" when  creating  a new  user  account.  For  example,  if you  have
  14. configured  FTP and  Web  servers, you  would  probably have  to create  a
  15. directory  within their  directories for  the  new user,  possibly copy  a
  16. skeleton "index.html" file  into the proper location, add  the user to the
  17. "ftp" and "www" groups and  so on.  All, naturally, without forgetting any
  18. vital step!
  19.  
  20. The adduser.local  program automates much  of this for you.   By modifying
  21. the program's  configuration file, /etc/adduser.local.conf,  to match your
  22. local  requirements,  this  program   can  automatically  add  a  user  to
  23. supplementary  groups,  create directories  and  symbolic  links and  copy
  24. skeleton files to the newly-created directories.
  25.  
  26. Note that once you install this program (and edit the configuration file),
  27. you will never  need to directly run adduser.local:  the Debian adduser(8)
  28. command automatically calls adduser.local with the correct parameters.  If
  29. you like,  however, you CAN  run adduser.local directly (try  the "--help"
  30. parameter for  a brief  command-line summary), such  as for  user accounts
  31. that have already been created.
  32.  
  33. The adduser.local program  is written in Perl (with  comments!), and comes
  34. with a sample configuration file that is extensively documented.  In fact,
  35. the sample adduser.local.conf file is  probably all you will need to read,
  36. once you  have installed the program.   A number of sample  files are also
  37. included in the "examples" directory --- do what you like with these.
  38.  
  39. To  illustrate the  program's simplicity,  the following  lines  have been
  40. taken almost verbatim from the sample configuration file:
  41.  
  42.     service = web
  43.  
  44.     user[web]       = www
  45.     addtogroup[web] = true
  46.     homedir[web]    = ""
  47.     subdir[web]     = "doc/users"
  48.     althome[web]    = false
  49.     mkdir[web]      = true
  50.     chgrpdir[web]   = true
  51.     mklink[web]     = true
  52.     linkname[web]   = "public_html"
  53.     skelfile[web]   = "index.html"
  54.     chgrpskel[web]  = true
  55.  
  56. Assuming adduser(8)  was called for the  user "john", and  the system user
  57. "www" belongs  to the group "www"  and has the  home directory "/home/www"
  58. (in actual fact,  all these values are taken  from the password database),
  59. the following actions are performed by this program:
  60.  
  61.   - the user "john" is added to the group "www",
  62.  
  63.   - the directory "/home/www/doc/users/john" is created, owned by the user
  64.     "john" and with group owner "www",
  65.  
  66.   - the link "public_html" is created  in the user "john"'s home directory
  67.     to point to this directory,
  68.  
  69.   - the  file "/etc/skel.other/index.html"  is copied  to  this directory,
  70.     owned by the user "john" and with group owner "www".
  71.  
  72. For more details, just read through the sample configuration file.
  73.  
  74.  
  75. INSTALLATION
  76. ============
  77.  
  78. Installation of  the adduser.local program  is quite easy.   Simply follow
  79. these steps as root:
  80.  
  81. 1. Copy the actual program to the correct location:
  82.  
  83.        # cp ./adduser.local /usr/local/sbin
  84.        # chmod 755 /usr/local/sbin/adduser.local
  85.  
  86. 2. Copy the configuration file to the correct location:
  87.  
  88.        # cp ./adduser.local.conf /etc
  89.  
  90. 3. Edit  the configuration file  with your  favourite editor.   You should
  91.    modify  the  file as  appropriate  to  your  requirements.  The  sample
  92.    configuration file is extensively self-documented.
  93.  
  94.        # editor /etc/adduser.local.conf
  95.  
  96. 4. Create the  "other" skeleton  directory and populate  it with  your own
  97.    files.  For example:
  98.  
  99.        # mkdir /etc/skel.other
  100.        # cp ./examples/skel.other/index.html /etc/skel.other
  101.  
  102. 5. You are finished.
  103.  
  104. The main reason  you have to install this program manually  is so that you
  105. do not forget to do Step 3, the most important one!
  106.  
  107.  
  108. LICENSE
  109. =======
  110.  
  111. The  adduser.local program  is  distributed  under the  terms  of the  GNU
  112. General Public  License.  The  copyright on this  program belongs  to John
  113. Zaitseff.  The actual license appears in the file COPYING, or, on a Debian
  114. GNU/Linux system, in the file /usr/share/common-license/GPL.
  115.  
  116. Even though  the GNU General Public  License does NOT require  you to send
  117. your modifications back to the author,  it is considered "good form" to do
  118. so,  as this  allows your  modifications  to be  incorporated into  future
  119. versions of the program, allowing others to benefit from them.
  120.  
  121. All files in the "examples"  directory are released into the public domain
  122. and are NOT covered by the GNU General Public License.
  123.  
  124.  
  125. FEEDBACK
  126. ========
  127.  
  128. Your  comments,  suggestions,  corrections  and  enhancements  are  always
  129. welcome!  Please send these to:
  130.  
  131. Postal:   John Zaitseff,
  132.           Unit 6, 116 Woodburn Road,
  133.           Berala, NSW, 2141,
  134.           Australia.
  135.  
  136. E-mail:   J.Zaitseff@zap.org.au
  137. Web:      http://www.zap.org.au/software/utils/adduser.local/
  138. FTP:      ftp://ftp.zap.org.au/pub/utils/adduser.local/adduser.local.tar.gz
  139.