[Maintain] Comments on INSTALL

Nathan Butcher xqufa at yokohama.riken.jp
Tue Mar 29 16:42:15 PST 2005


Check out the maintain wiki, I wrote a stack of docs for installing 
Maintain and getting it up and running. I wrote an install script for 
Debian as well.

http://wiki.osuosl.org/pages/viewpage.action?pageId=1525

Greg Connor wrote:

>Edited version attached.  Here are a couple of the suggested changes
>explained...  pretty minor stuff...
>
>
>
>44a45,51
>  
>
>>              [ Installation ]
>>
>>              There is currently no build or install script.  The tarfile
>>              containing the distribution should be extracted where you
>>              would like Maintain to be installed (we recommend extracting
>>              into /data/maintain/)
>>    
>>
>
>
>Added this to clarify the "install" :)
>
>
>77c85,86
><               initial setup we recommend leaving all modules disabled.
>---
>  
>
>>              initial setup we recommend leaving all modules disabled (i.e.
>>              defined with "enabled" set to 0.)
>>    
>>
>
>
>Minor clarification
>
>
>80,83c89,91
><               DocumentRoot.
>---
>  
>
>>              DocumentRoot, or if maintain is going to be a subdirectory,
>>              make a symlink from your current document root that points
>>              to the "docs" directory.
>>    
>>
>
>This seemed to work in my case... probably this is more relevant for a test
>server (where the URL might be http://server/maintain/ instead of at the top
>level).  For production uses, it will probably be at the top level of the
>webserver (or at least a virtual host)
>
>
><               5) Go into $prefix/bin and update any scripts you are planning
><               on using Look for my  = CHANGEME;
>
>I skipped this... I couldn't find anything that said CHANGEME and I haven't
>had to change anything in bin/ yet...
>
>
>88,89c96,97
><               templates/dhcp/dhcpd.conf.header.dist to
><               templates/dhcp/dhcpd.conf.header and update it.
>---
>  
>
>>              build/templates/dhcp/dhcpd.conf.header.dist to
>>              build/templates/dhcp/dhcpd.conf.header and update it.
>>    
>>
>
>Makes it clearer that we are talking about build/templates and not
>maintain/templates.
>
>
>91c99,100
><               7) Run perl $prefix/lib/perl/Local/Maintain/Makefile.PL
>---
>  
>
>>              6) cd to  $prefix/lib/perl/Local/Maintain/.  From there,
>>              run 'perl ./Makefile.PL'
>>    
>>
>
>cd seemed to be required for this step
>
>
>
>--
>Greg Connor <gconnor at sgi.com>
>Netops Services Group
>
>------------------------------------------------------------------------
>
>--------------------------------------------------------------------------
>---------                Maintain -- INSTALL                     ---------	 
>--------------------------------------------------------------------------
>		  $Id: not checked in /gconnor $
>--------------------------------------------------------------------------
>
>Installing Maintain:
>
>For information Maintain is designed to do see ./README 
>If you are doing an upgrade see ./UPGRADE 
>
>-------------------------------------------------------------------------------
>
>1. Required Components:
>
>	Maintain was developed with the following software versions. We
>	recommend use of Apache-ssl or mod_ssl with Apache rather than just
>	plain Apache.
>
>	Base:
>		Apache		>= 1.3.29	http://www.apache.org
>		PHP		>= 4.1.2	http://www.php.net
>		MySQL		>= 3.23		http://www.mysql.com
>		Perl		>= 5.6.1	http://www.perl.com
>		PHP-LDAP	>= 4.1.2	http://www.php.net
>		PEAR					http://pear.php.net	
>	DNS:
>		djbdns	>= 1.05 http://cr.yp.to/djbdns.html
>	DHCP:
>		ISC dhcpd	>= 3.0 
>
>-------------------------------------------------------------------------------
>
>2. Setting Up
>
>	Its highly recommended that you read README.design at some point to get
>	an idea of the high-level design of Maintain and how to best leverage
>	it in your environment.
>
>		[ Definitions ]
>
>		$prefix == Location where you extracted maintain
>		$web_prefix == URL of maintain
>		
>		[ Installation ]
>
>		There is currently no build or install script.  The tarfile
>		containing the distribution should be extracted where you
>		would like Maintain to be installed (we recommend extracting
>		into /data/maintain/)
>
>		[ Setting up the Database ]
>		
>		The instructions below do not cover creating a user or setting
>		permissions.  For this you should consult a MySQL manual or use
>		a program like phpMyAdmin.  
>		
>		The symbols <username> and <table name> below are traditionally
>		both set to 'maintain'.
>		
>		1) Create a maintain database
>			'mysql -u <username> -p'
>			
>			Now you should be at a 'mysql>' prompt so create the
>			database
>			
>			'create database <table name> ;'
>											
>		2) mysql -u <username> -p <table name> <
>		$prefix/install/sql/maintain.sql
>
>		[ Setting up Config Options ]
>
>		1) Copy $prefix/config/maintain.cfg.dist to
>		$prefix/config/maintain.cfg
>
>		2) Edit $prefix/config/maintain.cfg and configure Maintain.
>		To get started, you must set the DB information, your auth 
>		type, web path and prefix. To set a var as false, comment it 
>		out with a #. For the initial setup you must have 
>		"auth_methods = mysql"
>
>		3) Move $prefix/modules/modules.php.dist to
>		$prefix/modules/modules.php and enabled in desired modules. For
>		initial setup we recommend leaving all modules disabled (i.e.
>		defined with "enabled" set to 0.)
>
>		4) Add $prefix/docs to your Apache-ssl config as the
>		DocumentRoot, or if maintain is going to be a subdirectory,
>		make a symlink from your current document root that points
>		to the "docs" directory.
>
>		5) In $prefix/build/templates copy or mv all .dist or -default
>		files to their normal names and update them with your localized
>		information. For example copy
>		build/templates/dhcp/dhcpd.conf.header.dist to
>		build/templates/dhcp/dhcpd.conf.header and update it.
>
>		6) cd to  $prefix/lib/perl/Local/Maintain/.  From there, 
>		run 'perl ./Makefile.PL'
>
>		7) Run 'cd $prefix/lib/perl/Local/Maintain/; make' to build the
>		perl libraries. (Anytime you change Maintain.pm you need to run
>		the 'make' command from this directory again.)
>
>		8) Edit $prefix/bin/build-all to determine where you want to
>		push things and how they are pushed to your DNS and DHCP
>		servers.  We currently assume Debian paths for dhcp3, bind9 and
>		the radius configurations.
>
>
>		[ Web Interface Setup ]
>
>		1) Open a web-browser and go to $web_prefix and login as
>
>			Username: admin
>			Password: changeme
>
>		NOTE: As of 2.4.0 an update script will request to be ran.  If this is
>		a new install simply remove docs/update.php
>
>		2) You will be required change your password, and create your
>		first zone before you continue
>
>
>		[ First Network Setup ]
>
>		* See README.design for more information *
>
>		1) Go to the Admin section and create a new IP Block for your
>		IP space.  Make sure it's enabled.
>
>		2) Create the first subnet within the bound of your IP Block.
>		Assign any DHCP options to this subnet (router & subnet mask)
>
>		3) Create a Master Domain. 
>
>		4) Edit the zone created during setup and add this new domain
>		as an allowed domain.
>
>		5) Create a new range that fits inside your subnet.
>
>		6) Assign this new range to your zone. 
>
>		You should now be able to create hosts in this zone and assign
>		them to the new range and domain. 
>
>
>		[ Cron Setup ]
>
>		1) This will depend on your system, setup cron to run
>		$prefix/bin/maintain-update however often you would like it to
>		build the files. Make sure you edit $prefix/modules/config.php
>		to reflect the new build time so that TTL appears correctly
>
>		2) $prefix/bin/maintain-update is the main wrapper script that
>		runs $prefix/bin/build-all. $prefix/bin/build-all is the script
>		that builds any configuration files defined to be built in
>		$prefix/config/maintain.cfg as well as pushing those out to the
>		paths listed in $prefix/bin/build-all.  Please read
>		README.design for more information on usage.
>
>		3) Setup cron jobs, or scripts run from within maintain-update
>		that rsync, or copy the new configs out to your servers. For
>		now you are on your own for this step.
>
>-------------------------------------------------------------------------------
>
>  
>
>------------------------------------------------------------------------
>
>_______________________________________________
>Maintain mailing list
>Maintain at lists.osuosl.org
>http://lists.osuosl.org/mailman/listinfo/maintain
>  
>


More information about the Maintain mailing list