EPP-DRS User manual

Revision date: 30/01/08
Copyright © 2005-2008 Webta Labs.

Table of contents

1. Introduction
2. Pricing and licensing
3. Available registry modules
4. Available payment modules
5. Installation
1. System requirements
2. Deployment
3. Configuration
   1. Configure application
   2. Enable modules
   3. Prepare registry modules
   4. Configure modules
   5. Configure pricing
4. Localization and customization
6. Extending
   1. Creating custom modules

1. Introduction

EPP-DRS (EPP Domain Registration System) is a full-cycle domain registration and management system. It allows you to run an automated domain registration service, with ability for your clients to register, renew, transfer domain names.
System web interface consists of 3 areas: domain order wizard, Registrant control panel and Registrar control panel.
EPP-DRS is built on a solid framework with a modular structure, which allows implementation of custom registry and payment modules, as described in API Documentation.

Please visit EPP-DRS product website for latest information and updates.

2. Pricing and licensing

For latest pricing and licensing options, please check EPP-DRS product website

3. Available registry modules

4. Available payment modules

5. Installation

5.1. System requirements

EPP-DRS requires a webserver and can run on any operating system, as long as the following requirements are met:

• PHP 5.2.0 or higher,
• MySQL 4.1 or higher (MySQL 5.0 or higher preferred).

Required PHP configuration options:

• PHP must be able to execute binary programs, thus safe_mode must be set to Off

Required PHP extensions:

• Zend Optimizer
• cURL + SSL
• Sockets (--enable-sockets) with SSL support (--with-openssl)
• GetText
• SimpleXML
• mcrypt
• mhash

Required binary utilities:

• GPG (GnuPG) (SRSPlus module only)

5.2. Deployment

1. Copy files
   
   
   Note: If you are using FTP to upload files, make sure that you are uploading in binary mode!
   
   Copy contents of app folder on your webserver.
   Only app/www folder must be readable by webserver.
   For example, if you web root is /home/user/public_html, app/www folder should be copied to /home/user/public_html folder.
   Other files and folders in app folder should be copied to /home/user/
   
   
2. Set folders permissions
   Change permissions for cache folder (and its subfolders) and logs folders to 777 (world-writable),
   On Unix systems you can run in console: sh preinstall.sh
   
   
3. Create database
   
   • Create MySQL database and import database dump from sql/database.sql file
   • Edit database connection details in etc/config.ini file



4. Add cronjobs
   
   For system to work properly, it needs to run a few tasks periodicaly.
   A following recurring tasks need to be sheduled:
   
   

   Path to routine	Periodicity	Performed actions
   cron/delete_unpaid_domains.php	Daily	Deletes incompleted orders that are older than 5 days.
   cron/old_users.php	Daily	Deletes users that dont have active domains or paid invoices.
   cron/renew.php	Daily	Sends notifications to registrants about expiration of their domains (Configuring registry modules section explains how to configure notification dates). Generates invoices for domain renew.
   cron/transfer.php	Every 30 minutes	Checks a status of domain transfers and performs appropriate updates in database and domain contacts.
   cron/pollqueue_event.php	Every 5 minutes	Retrieves messages from poll message queue on EPP server and calls appropriate handlers.

   
   A sample crontab entries on Unix system will look like:
   
   0 0 * * * /path/to/php -q /path/to/app/cron/delete_unpaid_domains.php
0 0 * * * /path/to/php -q /path/to/app/cron/old_users.php
0 0 * * * /path/to/php -q /path/to/app/cron/renew.php
*/30 * * * * /path/to/php -q /path/to/app/cron/transfer.php
*/5 * * * * /path/to/php -q /path/to/app/cron/pollqueue_event.php
   Where /path/to/php is a path to php binary and /path/to/app - path to EPP-DRS folder.

5.3. Configuration

5.3.1. Configure application

1. Change default admin password
   Log in to registrar admin area by http://app-installation-url/admin/ with Login admin and password admin
   Go to Settings->General and change password and login (if needed),
   
   
2. E-mail settings
   If your PHP configuration allows you to send email with default mail() function, leave Under Settings → General → E-mail settings → SMTP connection field empty.
   If you are going to use SMTP connection, format of the value should be: user:password@host:port
   In most cases, port value should beset to default value of 25.
   
   
3. Registry options
   Settings → General → Registry options → Default NS fileds are default nameserver hosts that will be assigned to newly registered domains. These can not be empty and must be a valid nameservers.

5.3.2. Enable modules

5.3.3 Prepare registry modules

5.3.3.1 Prepare EPPGR module

1. Add your server host IP address in .GR registry web interface
   Log in to a test or real registry web interface and add IP address of your server. Note that server host IP address and your website IP address may differ. Contact your server administrator to obtain correct IP address.
   
   
2. Copy a .GR registry client certificate
   Take an SSL certificate that was given to you by .GR registry and copy it to to following path: modules/registries/EPPGR/ssl/epp.pem
   This is not needed for test mode, as test certificate already exists in the above path.
   


3. Configure connection
   
   EPP host for testing registry server is: https://devepp.ics.forth.gr:700/epp/proxy.
   For production registry: https://regepp.ics.forth.gr:700/epp/proxy
   
   
   Note: Your firewall must be configured to accept connections on TCP ports 700 and 800.

5.3.4. Configure modules

After needed modules are configured, enable each one by clicking Configure.

5.3.5. Configure pricing

5.4. Localization and customization

Interface customization

Email message customization

Localization

1. Create a language file
   • Copy app\lang\en_US\LC_MESSAGES to app\lang\ll_CC\LC_MESSAGES,
     where ll is a two-letter language code, according to ISO 639 standard, CC is two-letter country code, according to ISO 3166 standard
   • Translate strings in default.po file,
   • Generate a binary default.mo file. We recommend using poedit for this.
     
     
2. Translate templates
   • Copy app\templates\en_US toapp\templates\ll_CC,
     where ll is a two-letter language code, according to ISO 639 standard, CC is two-letter country code, according to ISO 3166 standard
   • Translate template files.

6 Extending EPP-DRS

6.1. Creating custom modules