docs/README
author rejo
Thu, 27 Dec 2007 12:32:25 +0000
changeset 52 aa5bae344805
parent 8 47dd15d8bb8c
child 64 dab0e9deeb67
permissions -rw-r--r--
[feladat @ 99] Update of docs/README file with a new description and download instructions. Fixed a typo as well.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
52
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
     1
What is PowerAdmin?
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
     2
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
     3
52
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
     4
The project's purpose is to create and maintain a friendly web-based DNS
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
     5
administration tool for the PowerDNS DNS server. The most recent version
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
     6
has full support for all zone types, support for supermasters, multi-
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
     7
language support and more.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
     8
52
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
     9
See <https://code.krikkit.nl/trac/poweradmin/wiki/Features> for a list
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    10
of features.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    11
52
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    12
The original PowerAdmin code was written by Trancer and Sjeemz. This
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    13
version ("a complete(r) PowerAdmin) is an adaption by Rejo Zenger. Many
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    14
people have contributed to the current code. For a list of contributors,
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    15
please see <https://code.krikkit.nl/trac/poweradmin/wiki/Credits>.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    16
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    17
52
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    18
Where to get PowerAdmin?
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    19
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    20
52
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    21
At <https://code.krikkit.nl/trac/poweradmin> you can download the most
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    22
recent version. 
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    23
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    24
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    25
Requirements
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    26
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    27
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    28
- PowerDNS, versions 2.1 through 2.9.19 have been tested, others might
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    29
  work as well. See <http://www.powerdns.com>.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    30
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    31
- MySQL or PostgreSQL. Both MySQL versions 4 and 5 have been reported
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    32
  to work, 5.0.22 has been tested.
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    33
  
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    34
- A webserver that support PHP 4 or 5. Apache 2.0.55 has been tested.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    35
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    36
- PHP. At least version 4.2.1. Version 5.1.2 has been tested. It needs
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    37
  the mysql or pgsql extension, as well has PEAR. 
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    38
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    39
- PEAR::MDB2 (2.4.0 has been tested) and PEAR::MDB2_Driver_mysql
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    40
  (1.4.0 has been tested) or PEAR::MDB2_Driver_pgsql.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    41
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    42
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    43
Installing
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    44
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    45
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    46
Upgrading? See section "Upgrading". 
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    47
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    48
- Install PowerDNS with a mysql or pgsql backend.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    49
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    50
- Install MDB2 and MDB2_Driver_mysql (or pgsql equivalent) packages of
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    51
  PEAR. You can install PEAR on a Debian-based server by installing
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    52
  the package php-pear. Make sure php-cli can access the mysql module
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    53
  (uncomment the line "extension=mysql.so" in /etc/php5/cli/php.ini).
52
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    54
  The additional PEAR packages can be installed using the "pear 
aa5bae344805 [feladat @ 99]
rejo
parents: 8
diff changeset
    55
  install" command.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    56
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    57
- Add a SQL user for poweradmin that is granted SELECT, INSERT,
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    58
  DELETE, UPDATE and CREATE actions.
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    59
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    60
- Untar and gunzip the poweradmin package in your web dir. This will
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    61
  create a directory "poweradmin-VERSION", we will refer to this
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    62
  directory as "poweradmin/".
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    63
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    64
- In the 'poweradmin/inc" directory the file "config-me.inc.php".
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    65
  Edit this file to suit your environment. Then rename this file to
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    66
  config.inc.php to be able to load the site. The website will not
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    67
  work properly without a config, so pay attention to your config!
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    68
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    69
- Next, go to <http://yourserver/poweradmin/install.php>
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    70
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    71
- Fill in the required information to make an administrator login for
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    72
  your PowerAdmin. If all goes well, the user is added, and you can
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    73
  log in using that username. Do not forget to remove install.php from
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    74
  the webdir!
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    75
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    76
- Finaly, run <http://yourserver/poweradmin/test_setup.php> to see if
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    77
  everything is setup correctly. This test also includes the
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    78
  functionality testing of your PowerDNS records (whether you
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    79
  have read/write access or not).
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    80
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    81
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    82
Upgrading from 1.2.7-patched
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    83
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    84
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    85
If you are upgrading from 1.2.7-patched, there is not much you need to
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    86
do. The only thing that is needed is install PEAR packages MDB2 and
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    87
MDB2_Driver_mysql (or MDB2_Driver_pgsql). This can be done by running
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    88
the commands "pear install MDB2 ; pear install MDB2_Driver_mysql".
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    89
Make sure php-cli can access the mysql extension by uncommenting the
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    90
line "extension=mysql.so" in /etc/php5/cli/php.ini
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    91
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    92
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    93
User levels explained
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    94
-----------------------------------------------------------------------
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    95
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    96
[x] = yes   [ ] = no
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
    97
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    98
User    Permission to   Permission to  Permission to    Permission to
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
    99
Level   change own      change other   create domains   add/modify
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   100
        domain(s)       domain(s)                       users
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
   101
8
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   102
 1           [x]             [ ]            [ ]              [ ]
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   103
 5           [x]             [x]            [x]              [ ]
47dd15d8bb8c [feladat @ 20]
rejo
parents: 1
diff changeset
   104
 10          [x]             [x]            [x]              [x]
1
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
   105
58094faf794d [feladat @ 2]
rejo
parents:
diff changeset
   106