Update INSTALL.md

Péter Szládovics
1 parent 0404c6af
Showing 1 changed file with 65 additions and 12 deletions
INSTALL.md
@@ -25,9 +25,9 @@ Unpack contents to somewhere on your server (eg. /var/www/html/smbind-ng) and
 setup your virtual server to access by default the index.php.
 ### Configuration directories and files
-1. Create a subdirectory with full permission to user of your webserver for keeping
-your zones. You need to make it readable for bind.
-Recommended solution: owner of dyrectory let the root user and bind group,
+1. Create a subdirectory with full permission to user of your webserver for
+keeping your zones. You need to make it readable for bind.  
+  Recommended solution: owner of directory let the root user and bind group,
 webserver user let the member of the bind group, and the directory let writable
 by owned group.
 2. Create two file with same permissions in this directory for saving zone
@@ -37,14 +37,14 @@ slave.conf) - eg. touch master.conf.
 slaves) with same permissions at the step 1.
 ### Modify bind configuration
-On your bind options set this folder to use with 'directory' option and
-'managed-keys' option (folder created at the step 3 above).
+On your bind options set this folder to use with *directory* option and
+*managed-keys* option (folder created at the step 3 above).  
 Include the master and slave configuration files into your bind config - what
 created at the step 2.
 ### Database
 Create a database user with full permission to access a non existing database
-with any name.
+with any name.  
 Log in your database server with that user, and create an empty database.
 Take the initial database dump, and load it to this schema with this newly
 created user.
@@ -55,12 +55,65 @@ See configuration parameters below
 ### DNSSEC related options
 #### Bind options
+In your bind configuration set the following options:
+
+*dnssec-enable yes;*  
+*dnssec-validation auto;*  
+*dnssec-lookaside auto;*
+
+And then restart your bind daemon.
 #### Roller daemon
 Create a directory for keeping file of roller daemon, and add write permissions
-for the webserver user group. eg. 
-    setfacl -b /etc/rollrecdir
-    setfacl -m 'www-data:rwx' /etc/rollrecdir
-Set up this directory for roller daemon to use this directory for rolling zones
-    eg. in this /etc/default/rollerd file use similar option:
-        DAEMON_OPTS="-rrfile /etc/smbind/rollrec/zones.rollrec"
 \ No newline at end of file
+for the webserver user group. eg.
+
+*setfacl -b /etc/rollrecdir*  
+*setfacl -m 'www-data:rwx' /etc/rollrecdir*  
+
+Set up this directory for roller daemon to use this directory for rolling zones.
+eg. in your /etc/default/rollerd file use similar option with this:
+
+*DAEMON_OPTS="-rrfile /etc/smbind/rollrec/zones.rollrec"*
+
+And then reload your roller daemon.
+
+## Configuration parameters
+The application has a *config.php* file in the *config* directory of the root
+of your SMBind-ng webapp directory.
+
+Format: $_CONF['variablename'] = value;
+
+Variables (mark **bold** for the required parameters):
+
+**db_type** - Type of the database (eg. 'mysql')  
+**db_user** - Name of the owner of database schema (eg. 'smbind')  
+**db_pass** - Password of the user above  
+db_host - Resolvable name or IP address of the database host (default:
+'localhost')  
+db_port - Port number of the database server (default: 3306 or 5432 depends on
+db_type)  
+**db_db** - Name of the database schema  
+**smarty_path** - Place of the smarty installation  
+**peardb_path** - place of your PEAR db  
+tmp_path - Path of your tmp directory (default: install path/tmp)  
+roller_conf - Path of your roller daemon config (configured in DAEMON_OPTS).
+Required for DNSSEC abilities.  
+isdnssec - enable or disable DNSSEC abilities (true/false)  
+recaptcha - enable or disable recaptcha at login screen (true/false)  
+rc_pubkey - Your public recaptha key (required for recaptcha)  
+rc_privkey - Your private recaptcha key (required for recaptcha)  
+nocaptcha - Array of your recaptcha whitelist. If you do not want to recaptcha
+when you access the webapp from specified hosts, you need to set up their IP
+addresses as followings:  
+*array(  
+'1.2.3.4',  
+'2.3.4.5',  
+);*  
+title - Title string at the top of your SMBind-ng screen (eg. 'My DNS zones')  
+footer - Footer string at the bottom of your SMBind-ng screen (eg. 'Company
+Name')  
+staticdomain - If you want to access your static files (.css and .js) through
+other virtual host, then you need to configure it in your webserver, and just
+set it (eg. 'static.mydnsservice.local'). There are only two static files in
+your SMBind-ng installation, so I think you don't really need this - but who
+knows?