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