source: trunk/INSTALL@ 536

Last change on this file since 536 was 530, checked in by Kris Deugau, 11 years ago

/trunk

Add UPGRADE file to document process and gotchas (if any) for upgrading
between neighbouring releases. New entries will be added to the top for
convenience.
Update INSTALL slightly to reflect requirements for new features.

  • Property svn:keywords set to Date Rev Author Id
File size: 3.3 KB
RevLine 
[218]1$Id: INSTALL 530 2013-06-25 21:55:27Z kdeugau $
[217]2
3Requirements
4============
5
6- Any CGI-capable web server that can execute arbitrary files or
7 files with administrator-defineable extensions
[218]8- PostgreSQL >= 7.4. It should be possible to trivially convert to
9 other DBMSes, however I recommend against any that don't fully
10 support transactions on all changes.
[217]11- Perl >= 5.6
12 - Standard modules:
13 These should be included in any base Perl install
14 - CGI::Carp
15 - POSIX
16 - Text::Wrap - for WHOIS response linewrapping
17 - Extra modules:
18 - CGI::Simple
19 - HTML::Template
20 - CGI::Session
21 - Crypt::PasswdMD5 (primary password encryption)
22 - Digest::MD5 (for imported VegaDNS passwords)
23 - Net::Whois::Raw
24 - Net::DNS
[530]25 - Net::SMTP
[217]26 - DBI
27 - DBD::Pg
28 - NetAddr::IP >= 4.x. 3.x may work, however 4.x has been out for
29 more than 4 years.
[219]30 - Frontier::Responder (only required if using dns-rpc.cgi)
[530]31 - FCGI (only required if you want to run the RPC script as FastCGI)
[218]32- tinydns - support for other DNS server software is planned
[217]33
[530]34
[217]35Installing DeepNet DNS Administrator
36====================================
37
381) Untar in a convenient location. You should be able to simply use the
39unpacked tarball as-is, or you can run "make install" to install files
[218]40in /usr/local/share/dnsadmin-#VERSION#, with configuration in
41/usr/local/etc/dnsdb.
[217]42
[218]43The Makefile supports substitution on most standard GNU/FHS-ish paths,
44so you could also run:
[217]45
46 make install prefix=/opt
47
48to install it under /opt.
49
50The Makefile also supports DESTDIR for packaging, so you can use:
51
52 make install datadir=/usr/share sysconfdir=/etc DESTDIR=/tmp/dnsdbpkgroot
53
54to install for packaging under /tmp/dnsdbpkgroot with the core scripts
55and HTML packaged under /usr/share/dnsdb-#VERSION#, and the configuration
[218]56packaged under /etc/dnsdb.
[217]57
[218]582) Configuration: By default DNS Administrator looks for configuration in
59/etc/dnsdb/dnsdb.conf. Edit this file with the database name, user, and
60password, and the database host if necessary.
[217]61
[218]62Setting the options under the "mail" heading is also recommended.
[217]63
[218]643) As a Postgres superuser, create a database user and the database (replace
65the database name, user and password as appropriate):
66
[217]67shell> psql template1
[218]68pg# create user dnsdb with password "dnsdbpwd";
69pg# create database dnsdb owner dnsdb;
[217]70
[218]71Create the inital tables using dns.sql:
[217]72
[218]73shell> psql -U dnsdb dnsdb <dns.sql
[217]74
[218]754) Configure your webserver to call the DNS Administrator scripts
[219]76at an appropriate web path. A webroot pointing to the unpacked tarball
77directory or the default install location /usr/local/lib/dnsadmin-#VERSION#
78should work fine; a directory alias under an existing virtual host should
79work as well.
[217]80
81The directory containing the HTML and scripts must have at least the
82following Apache directives (or other server equivalent) set:
83
84 Options ExecCGI IncludesNoEXEC
85
[218]865) A default user "admin", password "admin" is created when you create
87the initial tables in step 3. You should at least change the password
88on this account, or create another superuser account and remove this
89one.
[217]90
91---
92
[218]93Basic installation should now be complete! Log in and start adding
[530]94your domains and reverse zones and their records.
[217]95
[218]96A minimal export script is included (export.pl). This should be modified
97to create the tinydns data file where appropriate for your installation,
98and set to be called from cron on a regular basis.
Note: See TracBrowser for help on using the repository browser.