ispman/docs AUTH_LDAP_README,NONE,1.1 INSTALL,1.2,1.3 TODO,1.1,1.2

Update of /cvsroot/ispman/ispman/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10677

Modified Files:
	INSTALL TODO 
Added Files:
	AUTH_LDAP_README 
Log Message:
Rewrite INSTALL, merged Quickstart, separated AUTH_LDAP

--- NEW FILE: AUTH_LDAP_README ---
About Installing Webservers for Customers.
-----------------------------------------
You can have one or more webservers installed.  When creating a vhost, you can
tell ispman which webserver it belongs to, this lets you distribute the load
across mulitple servers or distribute for other reasons. 

Example: you may want to put 
* customer who requires Oracle and jserver on
  a Solaris box with these features
* customers who require PHP on a Linux box
* some friends (non-paying customers) on an old Indy
etc
etc


For the customer webservers which your client will access,
you may need to have auth_ldap compiled in as a module.

Auth_ldap is a module that provides authentification services by looking
up information in the LDAP directory.
This module is only needed if you wish to use the Access control feature of
the customer control panel.

You can download auth_ldap from its homepage
http://www.rudedog.org/auth_ldap

You don't need to recompile your Apache server if it is compiled with loadable 
modules support

To check if you Apache binary is compiled with loadable module support
run

/path/to/your/httpd -l

look for mod_so.c in the result. If you see it, then your server supports
loadable modules.

For help on building the auth_ldap module see
http://www.rudedog.org/auth_ldap/1.6/auth_ldap.html#building

I normally compile with
./configure --activate --with-ldap-sdk=openldap --with-apxs=/path/to/apxs
make all install


You will be prompted for a username/pass
The username is the same as you set for the admin
example, if you set
uid=ispman, ou=ispman, o=ispman

then the username is "ispman"
and the password that you set for the admin


Index: TODO
===================================================================
RCS file: /cvsroot/ispman/ispman/docs/TODO,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- TODO	20 Jun 2004 14:06:18 -0000	1.1
+++ TODO	21 Jun 2004 08:14:02 -0000	1.2
@@ -10,4 +10,4 @@
 - custom hooks for create/delete user/vhost/domain
 - forms for reseller/client management
 - caching of data to enhance performance
-- generic quota solution
\ No newline at end of file
+- generic quota solution

Index: INSTALL
===================================================================
RCS file: /cvsroot/ispman/ispman/docs/INSTALL,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- INSTALL	24 Apr 2003 20:24:29 -0000	1.2
+++ INSTALL	21 Jun 2004 08:14:02 -0000	1.3
@@ -1,19 +1,146 @@
-see Quickstart.txt.
+Installing ISPMan 
+=================
+In order to use ISPMan, you will need an ldap server and a web server.  ISPMan
+is developed using OpenLDAP and Apache.  This file goes over the process for
+installing the ispman files, populating a new ldap tree and setting up a
+virtual host for apache.
 
-Keep this directory around. In case we release new fixes for 
-this version you can simply update it from CVS.
+Beyond this file, the next step is configuring individual applications such as
+postfix, pop3/imap and other applications to query the ldap tree.
 
-To update from CVS type
-cvs login  (when promted for password, just hit enter)
-cvs -z3 update -dP
+Quickstart
+----------
+This is the quick process to install or upgrade.  See the sections below for
+detailed installation.
+    cvs -z3 update -dP
+    ./configure
+    make ispman install_ispman_common install_ispman_web
 
-then do the usual install
-./configure
-make ispman
-make install_ispman_common
-make install_ispman_web
+Configure ldap server, then import ispman base into ldap with:
+    make ldif-install
 
-etc
-etc
+Setup apache vhost.
+Configure ispman through web interface.
+
+
+Installing ISPMan Files 
+-----------------------
+ISPMan is available as tar packages created at release intervals.  Bugfixes are
+made available only through CVS updates.  For version 1.2, the cvs tag is
+"rel_1_2-bugfixes".
 
+The default location for ispman is in /opt.  Extract and install the tar file:
+    cd /opt
+    tar xfz ispman-1.2.tar.gz
+    cd ispman-1.2
+
+Download the latest bug fixes from cvs:
+    cvs -z3 update -dP 
+
+Configure the install.  Default installation dir is /opt/ispman.  --prefix is
+not necessary unless you wish to change location.
+    ./configure --prefix=/path/to/ispman/directory
+
+Next you will be asked configuration questions.  Most of the configuration will
+end up in /opt/ispman/conf/ispman.conf.  Some will go in your ldap tree.  The
+ldap administrator password given here, is also set in the ldap server
+configuration and used to log in to the web interface.
+    make ispman
+
+Install the rest of the files.
+    make install_ispman_common
+    make install_ispman_web
+
+
+OpenLDAP Configuration
+----------------------
+The above commands generated slapd.conf and ldap.conf in tmp/conf.  They can be
+used to modify or replace your OpenLDAP's server and client configuration
+files, respectively.  Note that there may be some differences in paths with
+your unix distribution.
+
+Copy dnszone.schema, pureftpd.schema and ispman.schema from tmp/schema to your
+ldap server's schema directory.  This might be in paths like
+/etc/openldap/schema or /etc/ldap/schema, etc.  OpenLDAP comes with some schema
+files, and looking at your original slapd.conf, the openldap package or
+Makefile listings will tell you where they go.  These schema files need to be
+referenced in the slapd.conf file as well.
+
+You need at least the following schemas defined:
+    core.schema
+    cosine.schema
+    nis.schema
+    misc.schema
+    inetorgperson.schema
+    dnszone.schema
+    pureftpd.schema
+    ispman.schema
+
+Restart your ldap server and ensure that it started without errors.  Look in
+the log.  OpenLDAP logs to the LOCAL4 syslog facility by default, and many unix
+distributions don't listen or log this by default.  Starting the server with a
+debug option will print messages to the screen if the server fails to start.
+
+Populate the base ispman tree.  This will run ldapadd with the file
+tmp/ldif/ispman.ldif and can be substituted with other methods.
+    make ldif-install
+
+Run a test query to ensure ldap is working and the ispman base has been
+installed.  Here is an example that should print many variables like
+'ispmanVar:'.  Make sure this works before going any further.
+    ldapsearch -x -LLL ispmanVar=*
+
+Run an ispman command to test the ispman configuration against the ldap tree.
+Again fix errors before continuing.
+    /opt/ispman/bin/ispman.listVars
+
+
+Web Interface Configuration 
+----------------------------
+ISPMan has an Administrator Panel and a Customer Control Panel.  Both are
+cgi files installed in the same virtual host or directory tree.  These can be
+installed either with a dedicated webserver or appended on to an existing web
+server.  
+
+There are no special requirements for use with Apache Server.  Just create a
+regular virtual host such as the following.
+
+    <VirtualHost *>
+	ServerName ispman.yourdomain.tld
+	DocumentRoot /opt/ispman/htdocs
+	<Directory  /opt/ispman/htdocs>
+	    Options ExecCGI
+	    AddHandler cgi-script .cgi
+	    DirectoryIndex index.html index.cgi
+	    AllowOverride None
+	</Directory>
+    </VirtualHost>
+
+
+Restart the webserver and visit the following link to get the ispman web
+interface.
+    http://ispman.yourdomain.tld
+
+Select "Login as an Administrator".
+Login with username "ispman".
+The password is what you set for the LDAP administator.
+
+IMPORTANT:
+Before making any changes, click the "Configure" menu then setup "Hosts" and
+"HostGroups".  
+
+Next, browse throught the other configuration settings and make sure paths,
+commands, ip addresses and other settings are correct for your network.
+
+Without configuring hosts and hostgroups, ISPMan will just be a fancy LDAP
+browser/editor.  The hosts and host groups are VERY important.  They are the
+systems that do actual tasks like creating users, setting up DNS, etc.
+
+ISPMan's web interface only edits infomation in the LDAP tree.  The
+ispman-agents running on each node do the real work.  ISPMan writes tasks for
+them to perform in ldap.  These tasks are set by hostgroups, so it is VERY
+IMPORTANT that they are properly defined.  As an example, a "modifyDomain"
+request will go to dnsgroup.  An agent on a host sees the task in the ldap tree
+set for its hostgroup and make the change in the dns server.  If you have not
+defined dnsgroup properly, the request will be strayed.
 



-------------------------------------------------------
This SF.Net email is sponsored by The 2004 JavaOne(SM) Conference
Learn from the experts at JavaOne(SM), Sun's Worldwide Java Developer
Conference, June 28 - July 1 at the Moscone Center in San Francisco, CA
REGISTER AND SAVE! http://java.sun.com/javaone/sf Priority Code NWMGYKND