README

Project source
==============

This project is a fork from the project mentioned below. We wanted
to use it, but submitted patches have not been applied in the source.
We intend to merge commits from the original project to this one and
at the same time improve what's there.

To start, we're working to make the sources work on Debian Wheezy
both with and without SSL on the XML-RPC server and web frontend --
we found that without SSL it currently doesn't work.


Feel free to create issues at
     https://github.com/ehuelsmann/openipam/issues


Dependencies
============

Debian Wheezy Packages
----------------------

Prefix the package lists with 'apt-get install' to make sure you have the
packages installed.

 * Shared by all
   postgresql

 * Backend (XML-RPC webservices)
   python-cherrypy3 python-ldap python-psycopg2
   python-openssl python-sqlalchemy python-ipy python-cjson

 * Front-end (web interface)
   python-cherrypy3 python-openssl python-cheetah python-ipy python-cjson

 * DHCP server (openDHCP)
   python-psycopg2 python-sqlalchemy

 * DNS server (PowerDNS)
   pdns-server pdns-backend-pgsql

 * SSL for backend and/or frontend
   ssl-cert

The website https://code.google.com/p/openipam/wiki/Installation also
lists python-processing for the DCHP server, but that dependency has
been eliminated due to the use of python 2.7.


Other distros
-------------


Please provide your package naming.


Installation
------------

Assuming you want to install all components, these are the steps to get
openIPAM set up on Debian Wheezy, after installing all the dependencies
listed above:

  adduser --home /usr/local/openipam --disabled-password \
          --gecos "openIPAM User" openipam

  ## THIS BLOCK ONLY IF YOU WANT SSL -- START
  apt-get install  ssl-cert
  adduser openipam ssl-cert
  ## THIS BLOCK ONLY IF YOU WANT SSL -- END

  mkdir -p /var/lib/openipam/sessions/backend
  mkdir -p /var/log/openipam/backend
  mkdir -p /var/lib/openipam/sessions/web
  mkdir -p /var/log/openipam/web
  chown -R openipam /var/lib/openipam /var/log/openipam

  su - openipam
  svn co https://github.com/ehuelsmann/openipam/trunk/openipam .
  cd openIPAM/
  svn export openipam_config.example openipam_config
  exit


  su - postgres
  createuser --pwprompt --no-superuser --no-createdb
             --no-createrole openipam
  # createuser asks for a password here. Remember it, we need it later!
  createdb -O openipam openipam
  exit


  su - openipam
  (psql -d openipam -f openIPAM/sql/openipam_schema.sql 2>&1) \
    | tee log | grep 'ERROR'
  # IF THE ABOVE SHOWS NO OUTPUT, CHECK THE 'log' FILE TO SEE IF THE COMMAND
  # RAN AT ALL. IF THE 'log' FILE IS NON-EMPTY AND THERE ARE NO ERRORS,
  # THE DATABASE SCHEMA LOADED CORRECTLY
  exit


  # The cherrypy patch https://code.google.com/p/openipam/wiki/Installation
  # speaks of, is outdated information: the patch is no longer required


### WRITEME: Apache + mod_wsgi


### WRITEME: dhcpd


### WRITEME: Startup scripts




Original project
================





                        ___ ____   _    __  __ 
  ___  _ __   ___ _ __ |_ _|  _ \ / \  |  \/  |
 / _ \| '_ \ / _ \ '_ \ | || |_) / _ \ | |\/| |
| (_) | |_) |  __/ | | || ||  __/ ___ \| |  | |
 \___/| .__/ \___|_| |_|___|_| /_/   \_\_|  |_|
      |_|
               www.openipam.org                      


Copyright (C) 2007-2008 Utah State University - Information Technology
Licensed under the GNU General Public License v3. See COPYING for details.


INSTALLATION & CUSTOMIZATION
	http://code.google.com/p/openipam/wiki/Installation


DEPENDENCIES
	Power DNS server
	PostgreSQL server (with table_log if you want to keep track of changes)
	python-ldap (>= 2.2.0) *
	python-cherrypy3 (>= 3.0.3) (backend/web frontend)
	python-cjson (backend/web frontend)
	python-sqlalchemy (>= 0.4.6) (backend, dhcp)
	python-psycopg2 (backend, dhcp)
	python-openssl *
	python-ipy
	python-processing (for DHCP server)
	python-cheetah (for web frontend)
	hacked version of pydhcplib (included in source tree)

.