docs/README
author rejo
Wed, 27 Jun 2007 20:45:51 +0000
changeset 29 e1c60f72d494
parent 8 47dd15d8bb8c
child 52 aa5bae344805
permissions -rw-r--r--
[feladat @ 76] Changed some of the functions that are used for the listing of (all) zones. Instead of getting all zones from the database, it now only requests exactlty what it needs. Considerable perfomance improvement.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     1
What is Poweradmin?
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     2
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
     3
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     4
Poweradmin is a non-commercial front-end for the PowerDNS nameserver,
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     5
see <http://www.powerdns.com>. The goal of Poweradmin is to provide a
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     6
friendly management interface to the database backend of PowerDNS
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     7
which actually holds the DNS records. At this moment, both the mysql
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     8
and pgsql are supported. The interface allows add, modify and deletion
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     9
of both forward and reverse zones and has full IPv6 support.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    10
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    11
Poweradmin is written by Roeland Nieuwenhuis <trancer@trancer.nl>
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    12
and Sjeemz <sjeemz@sjeemz.nl>. It contains patches of Wim Moistry and
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    13
Dennis Roos.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    14
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    15
Please see CHANGES for a list of changes, CHANGES.pre-1.3.0 for a list
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    16
of changes prior to 1.3.0 release, README.i18n for information on the
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    17
multi language support, README.sequence for information the "sequence
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    18
updater" and the insertion of records and zones using other interfaces
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    19
than poweradmin.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    20
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    21
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    22
Where to get Poweradmin?
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    23
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    24
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    25
The Poweradmin website can be found at <http://www.poweradmin.org>.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    26
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    27
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    28
Requirements
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    29
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    30
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    31
- PowerDNS, versions 2.1 through 2.9.19 have been tested, others might
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    32
  work as well. See <http://www.powerdns.com>.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    33
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    34
- MySQL or PostgreSQL. Both MySQL versions 4 and 5 have been reported
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    35
  to work, 5.0.22 has been tested.
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    36
  
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    37
- A webserver that support PHP 4 or 5. Apache 2.0.55 has been tested.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    38
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    39
- PHP. At least version 4.2.1. Version 5.1.2 has been tested. It needs
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    40
  the mysql or pgsql extension, as well has PEAR. 
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    41
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    42
- PEAR::MDB2 (2.4.0 has been tested) and PEAR::MDB2_Driver_mysql
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    43
  (1.4.0 has been tested) or PEAR::MDB2_Driver_pgsql.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    44
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    45
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    46
Installing
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    47
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    48
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    49
Upgrading? See section "Upgrading". 
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    50
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    51
- Install PowerDNS with a mysql or pgsql backend.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    52
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    53
- Install MDB2 and MDB2_Driver_mysql (or pgsql equivalent) packages of
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    54
  PEAR. You can install PEAR on a Debian-based server by installing
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    55
  the package php-pear. Make sure php-cli can access the mysql module
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    56
  (uncomment the line "extension=mysql.so" in /etc/php5/cli/php.ini).
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    57
  The addional PEAR packages can be installed using the "pear install"
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    58
  command (e.g. "pear install MDB2 ; pear install MDB2_Driver_mysql").
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    59
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    60
- Add a SQL user for poweradmin that is granted SELECT, INSERT,
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    61
  DELETE, UPDATE and CREATE actions.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    62
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    63
- Untar and gunzip the poweradmin package in your web dir. This will
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    64
  create a directory "poweradmin-VERSION", we will refer to this
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    65
  directory as "poweradmin/".
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    66
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    67
- In the 'poweradmin/inc" directory the file "config-me.inc.php".
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    68
  Edit this file to suit your environment. Then rename this file to
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    69
  config.inc.php to be able to load the site. The website will not
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    70
  work properly without a config, so pay attention to your config!
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    71
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    72
- Next, go to <http://yourserver/poweradmin/install.php>
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    73
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    74
- Fill in the required information to make an administrator login for
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    75
  your PowerAdmin. If all goes well, the user is added, and you can
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    76
  log in using that username. Do not forget to remove install.php from
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    77
  the webdir!
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    78
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    79
- Finaly, run <http://yourserver/poweradmin/test_setup.php> to see if
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    80
  everything is setup correctly. This test also includes the
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    81
  functionality testing of your PowerDNS records (whether you
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    82
  have read/write access or not).
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    83
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    84
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    85
Upgrading from 1.2.7-patched
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    86
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    87
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    88
If you are upgrading from 1.2.7-patched, there is not much you need to
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    89
do. The only thing that is needed is install PEAR packages MDB2 and
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    90
MDB2_Driver_mysql (or MDB2_Driver_pgsql). This can be done by running
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    91
the commands "pear install MDB2 ; pear install MDB2_Driver_mysql".
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    92
Make sure php-cli can access the mysql extension by uncommenting the
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    93
line "extension=mysql.so" in /etc/php5/cli/php.ini
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    94
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    95
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    96
User levels explained
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    97
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    98
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    99
[x] = yes   [ ] = no
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
   100
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   101
User    Permission to   Permission to  Permission to    Permission to
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   102
Level   change own      change other   create domains   add/modify
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   103
        domain(s)       domain(s)                       users
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
   104
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   105
 1           [x]             [ ]            [ ]              [ ]
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   106
 5           [x]             [x]            [x]              [ ]
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   107
 10          [x]             [x]            [x]              [x]
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
   108
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
   109