source: trunk/INSTALL@ 440

Last change on this file since 440 was 440, checked in by Kris Deugau, 14 years ago


Cosmetic fixup on "Add new assignment" alignment
Add note regarding symlinks for modules for if

running directly from the unpacked tarball

Clear local.css when creating tarball

  • Property svn:keywords set to Id
File size: 5.3 KB
1$Id: INSTALL 440 2010-07-20 21:27:14Z kdeugau $
6- Any CGI-capable web server that can execute arbitrary files or
7 files with administrator-defineable extensions
8- PostgreSQL >= 7.4. It should be possible to (fairly) trivially patch
9 the code for any other DBMS that supports:
10 - an IP address/CIDR netblock data type
11 - higher/greater, lower/less than, contains, and is-contained-by
12 operators
13- Perl >= 5.6
14 - Standard modules:
15 These should be included in any base Perl install
16 - File::Path
17 - CGI::Carp
18 - POSIX
19 - Sys::Syslog
20 - Extra modules:
21 - NetAddr::IP >= 4.x. 3.x may work, however 4.x has been out for
22 more than 4 years.
23 - DBI
24 - DBD::Pg
25 - Sys::SigAction. This isn't strictly required; it's used in an
26 example hook for validating customer IDs against an external
27 database. It could arguably be replaced with sigaction() from the
28 POSIX module when using Perl >= 5.8.2. See eg Sys::SigAction on
29 CPAN (
30 for some thoughts on the gritty details.
32Installing the IPDB
351) Untar in a convenient location. You should be able to simply use the
36unpacked tarball as-is, or you can run "make install" to install files
37in /usr/local/lib/ipdb-#VERSION#, with configuration modules in
40The Makefile supports substitution on most standard
41GNU/FHS-ish paths, so you could also run:
43 make install prefix=/opt
45to install it under /opt.
47The Makefile also supports DESTDIR for packaging, so you can use:
49 make install libdir=/usr/lib sysconfdir=/etc DESTDIR=/tmp/ipdbpkgroot
51to install for packaging under /tmp/ipdbpkgroot with the core scripts
52and HTML packaged under /usr/lib/ipdb-#VERSION#, and the configuration
53modules packaged under /etc/ipdb-#VERSION#.
552) Configuration: These module files will either be in the cgi-bin/
56directory from the unpacked tarball, or /usr/local/etc/ipdb-#VERSION#
57if installed with 'make install'.
58 a) Edit you need to set the database DSN and
59 company info. You should probably also set the syslog facility and
60 default custid.
61 b) Edit as needed to validate customer IDs.
634) Create the database, and the inital tables using cgi-bin/ipdb.psql.
655) Configure your webserver to call the IPDB scripts at an appropriate
66web path. A webroot pointing to the HTML files (first level under
67the ipdb-#VERSION#/ tarball directory, or /usr/local/lib/ipdb-#VERSION#)
68with a symlink or alias for ip/ -> . should work fine; a server alias
69under an existing virtual host should work as well.
71Note that all URLs referenced internally currently assume they will be
72presented at http://host/ip/; you cannot put the IPDB at
75The directory containing the HTML and scripts must have at least the
76following Apache directives (or other server equivalent) set:
78 Options ExecCGI IncludesNoEXEC FollowSymlinks
806) User lists can be maintained two basic ways:
82 a) Use the built-in user manager to add and remove users. This
83 requires mod_auth_pgsql, configured with read/write access to the
84 IPDB users table. A default user admin, password admin, is created
85 in step 4 above - make sure to create a new user as an admin, and
86 remove the default user (or at least change its password).
88 b) Maintain an external .htpasswd file of your own, configured and
89 maintained however you like. In this case the
90 script should edited to match the .htpasswd filename/path and should
91 be called from cron to make sure new users get added to the
92 database, and old ones get deleted. This extra maintenance of user
93 lists is necessary to support the access controls, which are stored
94 in the database.
96You will have to either temporarily create a user "admin", so that user
97can grant other users priviledges, or run the following on the database:
99 UPDATE users SET acl='bacdsA' WHERE username='newadminuser';
101Replace 'newadminuser' as appropriate.
103If you don't do this, nobody will be able to make any changes; only grants minimal read access to new users.
1067) (optional) Pick a log facility by setting $IPDB::syslog_facility in, and tweak your syslog configuration to direct IPDB logging
108to a custom log. Most logging is at the level of "info" or "warn".
109Full changes are not logged. Logging verbosity isn't very high, so it
110may be acceptable to leave the log stream at the defaults.
114Basic installation should now be complete! Log in as an admin user,
115add your ARIN, RIPE, LACNIC, AfriNIC, or APNIC allocations and start
116documenting your netblock usage.
118If you want to export rWHOIS data, see
119for a place to start on setting up an rWHOIS server. Note that creates and maintains the net-<cidr> trees, all you have
121to do is configure the daemon itself. Schedule runs of
122cgi-bin/extras/ followed by rwhois_indexer (every hour
123should be plenty often). You'll need to fill in correct organization
124contact info in
126If you're just running from the unpacked tarball directory, you may need
127to create symlinks in cgi-bin/extras/ for and,
128pointing to ../ and ../ respectively. Otherwise won't be able to find these modules.
Note: See TracBrowser for help on using the repository browser.