docs/README
changeset 1 58094faf794d
child 8 47dd15d8bb8c
equal deleted inserted replaced
0:2cd8c1649ba9 1:58094faf794d
       
     1 1. What is PowerAdmin
       
     2 ------------------------------
       
     3 
       
     4 PowerAdmin is a non commercial front-end for the PowerDNS (www.powerdns.com) nameserver.
       
     5 The goal of PowerAdmin is to manage the (MySQL) database behind PowerDNS, which contains
       
     6 the DNS records.
       
     7 
       
     8 There have been some changes in this release, both of major and minor importance.
       
     9 Please read the following document to familiarize yourself with them. You are also
       
    10 requested to report any bugs should you encounter them.
       
    11 
       
    12 
       
    13 
       
    14 2. Where to get PowerAdmin
       
    15 ------------------------------
       
    16 
       
    17 The main location of PowerAdmin is http://www.poweradmin.org
       
    18 
       
    19 
       
    20 
       
    21 3. Notes
       
    22 ------------------------------
       
    23 
       
    24 
       
    25 3.1 Migrating
       
    26 ------------------------------
       
    27 
       
    28 If you are running a stone-age version of PowerAdmin read the following information!
       
    29 
       
    30 Due to some major changes in this release the current version of PowerAdmin
       
    31 supports gmysql backend. You are strongly advised to backup your data before running the
       
    32 migrator.php tool in your poweradmin directory. This is to protect you against any data
       
    33 loss should anything go wrong. We assume it all works properly, but due to a limited
       
    34 number of betatesters we cannot guarantee our tool is 100% bug free.
       
    35 
       
    36 !! Please be sure you have a working backup of your data !! 
       
    37 
       
    38 Do the following to migrate: 
       
    39 - rename the file migrator.php-pa in your webdir to migrator.php.
       
    40 - Go here to migrate it.
       
    41 It is recommended to synchronize your database aswell after the update
       
    42 
       
    43 
       
    44 3.2 DB Information
       
    45 ------------------------------
       
    46 
       
    47 For now on PowerAdmin supports PowerDNS' MySQL back-end only. If there is demand for other
       
    48 database layers support will be added in the near future. Of course, since the code is opensource,
       
    49 everyone who cannot wait is encouraged to plug in their own database layer (and if you dare, send the 
       
    50 code to us so we can evaluate it and maybe integrate it with the current PowerAdmin).
       
    51 We are still busy with PostGreSQL, but the experience needs a bit more tweaking for us.
       
    52 Time will release it, we cannot yet.
       
    53 
       
    54 By using PEAR::DB we are bound to have some way to keep track of indexes. This is done by using seperate
       
    55 tables called users_seq and zones_seq. Also records_seq will be there. This means that if you manually
       
    56 insert a record, chances are 90% that you will have corrupted workings of PowerAdmin (because the ID is
       
    57 not in order.) The problem can be solved by running the Synchronize Database tool (select it or use the
       
    58 seq_update.php url). This will let you resynch your indexes. It is also useful if you are migrating
       
    59 from 1.0 to 1.1 or higher.
       
    60 
       
    61 Read more about this in README-Sequence
       
    62 
       
    63 
       
    64 4. Documentation
       
    65 ------------------------------
       
    66 
       
    67 PowerAdmin has the following core features:
       
    68 
       
    69 - User Level dependant editing of domains. For example an administrator
       
    70   can edit all domains, while a user can for example only edit the domain(s)
       
    71   owned by him/her.
       
    72 
       
    73 - Simple administration of users that can access PowerAdmin.
       
    74 
       
    75 - Easy creating of domains. Next of that, the proper assignment of rights
       
    76   is simply and done within a few clicks.
       
    77 
       
    78 - Ability to apply a record-template when creating domains. For now, the template
       
    79   can only be configured in the config file, but this will be moved to a nice
       
    80   database-table soon.
       
    81 
       
    82 - Editting records in existing zones.
       
    83 
       
    84 
       
    85 5. Installation
       
    86 ------------------------------
       
    87 
       
    88 !! If you are updating, you should necessarily read paragraph 3 !!
       
    89 
       
    90 What you need:
       
    91 - PowerDNS (Duh!) (Versions 2.1 through 2.6 have been tested, others might work aswell)
       
    92   http://www.powerdns.com/
       
    93 - MySQL
       
    94   http://www.mysql.com/
       
    95 - An (Apache) webserver that supports php4 and php4-mysql. The PHP version must be at least 4.2.1.
       
    96   http://www.apache.org/
       
    97   http://www.php.net/
       
    98 
       
    99 First of all, install PowerDNS with it's MySQL Generic back-end.
       
   100 
       
   101 Next to the MySQL user you created for PowerDNS, you need a MySQL user for PowerAdmin that can do
       
   102 the following actions on the PowerDNS database you created: SELECT, INSERT, DELETE, UPDATE, CREATE.
       
   103 
       
   104 Untar/gzip poweradmin-VERSION.tar.gz in your webdir. This will create a directory called
       
   105 poweradmin-VERSION.
       
   106 
       
   107 In the 'inc' subdirectory of your newly created directory, you'll find a file called
       
   108 config-block.inc.php. Edit this file to suit your environment. Then rename it to
       
   109 config.inc.php to be able to load the site. The website will not work properly without a config,
       
   110 so pay attention to your configuration!
       
   111 
       
   112 Next, go to http://www.yourdomain.com/poweradmin-VERSION/install.php
       
   113 
       
   114 Fill in the required information to make an administrator login for your
       
   115 PowerAdmin. If all goes well, the user is made, and you can log in using that username.
       
   116 WARNING! Be sure to remove install.php from the webdir!
       
   117 
       
   118 After you are done, run http://www.yourdomain.com/poweradmin-VERSION/test_setup.php to see if
       
   119 everything is set up well.
       
   120 This test also includes the functionality testing of your PowerDNS records (whether you
       
   121 have read/write access or not)
       
   122 
       
   123 
       
   124 6. User levels explained
       
   125 ------------------------------
       
   126 User levels explained:
       
   127 
       
   128 [x] = yes
       
   129 [ ] = no
       
   130 
       
   131 User        Permission to           Permission to           Permission to           Permission to
       
   132 Level       change own              change other            create domains          add/modify
       
   133             domain(s)               domain(s)                                       users
       
   134 
       
   135  1               [x]                     [ ]                     [ ]                     [ ]
       
   136  5               [x]                     [x]                     [x]                     [ ]
       
   137  10              [x]                     [x]                     [x]                     [x]
       
   138 
       
   139 
       
   140 7. Further Info && Bugs
       
   141 ------------------------------
       
   142 
       
   143 The latest contact information can always be found at http://www.poweradmin.org .
       
   144 
       
   145 
       
   146 8. Links and more information
       
   147 ------------------------------
       
   148 
       
   149 http://www.poweradmin.org   Our main site
       
   150 http://www.powerdns.com		PowerDNS
       
   151 http://www.ietf.org		Information about DNS
       
   152 http://poweradmin.sf.net	PowerAdmin @ SourceForge
       
   153 http://www.apache.org/          The Apache Webserver
       
   154 http://www.php.net/             PHP programming language
       
   155 http://www.mysql.com/           MySQL database server
       
   156 
       
   157 9. Changes
       
   158 ------------------------------
       
   159 
       
   160 Changes for this version are:
       
   161 - Many many many bug fixes!
       
   162 - Enhanced sequence updater that is now smarter.
       
   163 - SOA Fields fixed.
       
   164 - Automatically SOA serial updating after each change in the DNS.
       
   165 - MASTER/SLAVE Functionality but that stays untested at the moment of writing. 
       
   166   Use the toggles with care, see the config-block.inc.php for more information.
       
   167 - Search abilities added thanks to DeViCeD
       
   168 - A lot of other stuff and minor details not worth mentioning that much.
       
   169 
       
   170 
       
   171 --------------------------------------------------------------------------
       
   172 Enjoy!
       
   173 
       
   174 There are some major changes, we would like feedback!
       
   175 See paragraph 7 for contact information.
       
   176 
       
   177 Regards,
       
   178 The PowerAdmin Team