https://github.com/internetee/registry

TLD Management Software
https://github.com/internetee/registry

domain epp registry ruby tld

Last synced: about 1 month ago
JSON representation

TLD Management Software

Host: GitHub
URL: https://github.com/internetee/registry
Owner: internetee
License: other
Created: 2014-05-29T12:13:02.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2026-02-26T20:42:25.000Z (about 2 months ago)
Last Synced: 2026-02-27T02:04:16.536Z (about 2 months ago)
Topics: domain, epp, registry, ruby, tld
Language: Ruby
Homepage:
Size: 127 MB
Stars: 49
Watchers: 9
Forks: 17
Open Issues: 316
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

Domain Registry
===============
[![Maintainability](https://qlty.sh/gh/internetee/projects/registry/maintainability.svg)](https://qlty.sh/gh/internetee/projects/registry)
[![Code Coverage](https://qlty.sh/gh/internetee/projects/registry/coverage.svg)](https://qlty.sh/gh/internetee/projects/registry)
[![Documentation Status](https://readthedocs.org/projects/eeregistry/badge/?version=latest)](http://docs.internet.ee/en/latest/?badge=latest)

Full stack top-level domain (TLD) management.

* [Documentation](#documentation)
* [Installation](#installation)
* [Deployment](#deployment)
* [Autotesting](#autotesting)

Documentation
-------------

* [EPP documentation](/doc/epp)
* [EPP request-response examples](/doc/epp_examples.md)
* [REPP documentation](https://internetee.github.io/repp-apidoc/)

Installation
------------

### Registry app

Registry based on Rails 4 installation (rbenv install is under Debian build doc)

Manual demo install and database setup:

cd /home/registry
git clone git@github.com:internetee/registry.git demo-registry
cd demo-registry
rbenv local 2.2.2
bundle
cp config/application.yml.sample config/application.yml # and edit it
cp config/database.yml.sample config/database.yml # and edit it
bundle exec rake db:setup:all # for production, please follow deployment howto
bundle exec rake bootstrap
bundle exec rake assets:precompile

### Apache (Debian 7/Ubuntu 14.04 LTS)

sudo apt-get install apache2

Enable ssl:

sudo a2enmod proxy_http
sudo mkdir /etc/apache2/ssl
sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/apache2/ssl/apache.key -out /etc/apache2/ssl/apache.crt
sudo a2enmod ssl
sudo nano /etc/apache2/sites-enabled/epp_ssl.conf

For Apache, registry admin goes to port 443 in production, /etc/apache2/sites-enabled/registry.conf short example:

```

ServerName your-domain
ServerAdmin your@example.com

PassengerRoot /usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini
PassengerRuby /home/registry/.rbenv/shims/ruby
PassengerEnabled on
PassengerMinInstances 10
PassengerMaxPoolSize 10
PassengerPoolIdleTime 0
PassengerMaxRequests 1000

RailsEnv production # or staging
DocumentRoot /home/registry/registry/current/public

# Possible values include: debug, info, notice, warn, error, crit,
LogLevel info
ErrorLog /var/log/apache2/registry.error.log
CustomLog /var/log/apache2/registry.access.log combined

SSLEngine On
SSLCertificateFile /etc/ssl/certs/your.crt
SSLCertificateKeyFile /etc/ssl/private/your.key
SSLCertificateChainFile /etc/ssl/certs/your-chain-fail.pem
SSLCACertificateFile /etc/ssl/certs/ca.pem

SSLProtocol -all +TLSv1.2
SSLHonorCipherOrder On
SSLCompression off
SSLCipherSuite EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH

RewriteEnginriteEngine on
RedirectMatch ^/$ /admin
RedirectMatch ^/login$ /admin/login

# for Apache older than version 2.4
Allow from all

# for Apache verison 2.4 or newer
# Require all granted
Options -MultiViews

Allow from none
Deny from all

Allow from all

```

Registrar configuration (/etc/apache2/sites-enabled/registrar.conf) is as follows:
```

ServerName your-registrar-domain
ServerAdmin your@example.com

RailsEnv production # or staging
DocumentRoot /home/registry/registrar/current/public

# Possible values include: debug, info, notice, warn, error, crit,
LogLevel info
ErrorLog /var/log/apache2/registrar.error.log
CustomLog /var/log/apache2/registrar.access.log combined

SSLProtocol -all +TLSv1.2
SSLHonorCipherOrder On
SSLCompression off
SSLCipherSuite EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH

RewriteEngine on
RedirectMatch ^/$ /registrar
RedirectMatch ^/login$ /registrar/login

# for Apache older than version 2.4
Allow from all

# for Apache verison 2.4 or newer
# Require all granted

Options -MultiViews

Allow from none
Deny from all

Allow from all

SSLVerifyClient none
SSLVerifyDepth 1
SSLCACertificateFile /home/registry/registry/shared/ca/certs/ca.cert.pem
SSLCARevocationPath /home/registry/registry/shared/ca/crl
# Uncomment in Apache 2.4
# SSLCARevocationCheck chain

RequestHeader set SSL_CLIENT_S_DN_CN ""
RequestHeader set SSL_CLIENT_CERT ""

SSLVerifyClient require
RequestHeader set SSL_CLIENT_S_DN_CN "%{SSL_CLIENT_S_DN_CN}s"
RequestHeader set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s"

SSLVerifyClient require
Options Indexes FollowSymLinks MultiViews
SSLVerifyDepth 2
SSLOptions +StdEnvVars +ExportCertData

```

Registrant configuration (/etc/apache2/sites-enabled/registrant.conf) is as follows:
```

ServerName your-registrant-domain
ServerAdmin your@example.com

RailsEnv production # or staging
DocumentRoot /home/registry/registrant/current/public

# Possible values include: debug, info, notice, warn, error, crit,
LogLevel info
ErrorLog /var/log/apache2/registrant.error.log
CustomLog /var/log/apache2/registrant.access.log combined

SSLProtocol -all +TLSv1.2
SSLHonorCipherOrder On
SSLCompression off
SSLCipherSuite EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH

RewriteEngine on
RedirectMatch ^/$ /registrant
RedirectMatch ^/login$ /registrant/login

# for Apache older than version 2.4
Allow from all

# for Apache verison 2.4 or newer
# Require all granted

Options -MultiViews

Allow from none
Deny from all

Allow from all

SSLVerifyClient require
Options Indexes FollowSymLinks MultiViews
SSLVerifyDepth 2
SSLOptions +StdEnvVars +ExportCertData

```

For Apache, REPP goes to port 443 in production, /etc/apache2/sites-enabled/repp.conf short example:
```

ServerName your-repp-domain
SSLEngine on
#SSLCipherSuite ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP:+eNULL
SSLCertificateFile /etc/apache2/ssl/apache.crt
SSLCertificateKeyFile /etc/apache2/ssl/apache.key

ProxyPass / http://localhost:8080/
ProxyPassReverse / http://localhost:8080/
ProxyPreserveHost on
RequestHeader set X_FORWARDED_PROTO 'https'

SSLVerifyClient none
SSLVerifyDepth 1
SSLCACertificateFile /home/registry/registry/shared/ca/certs/ca.crt.pem
SSLCARevocationPath /home/registry/registry/shared/ca/crl
# Uncomment this when upgrading to apache 2.4:
# SSLCARevocationCheck chain

RequestHeader set SSL_CLIENT_S_DN_CN ""
RequestHeader set SSL_CLIENT_CERT ""

Allow from none
Deny from all

Allow from all
SSLVerifyClient require
RequestHeader set SSL_CLIENT_S_DN_CN "%{SSL_CLIENT_S_DN_CN}s"
RequestHeader set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s"

```

For Apache, epp goes to port 700.
Be sure to update paths to match your system configuration.
/etc/apache2/sites-enabled/epp.conf short example:
```apache

Listen 127.0.0.1:8080

ServerName your-epp-backend-domain
ServerAdmin your@example.com

PassengerEnabled on
PassengerMinInstances 10
PassengerMaxPoolSize 10
PassengerPoolIdleTime 0
PassengerMaxRequests 1000
PassengerRoot "/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini"
PassengerRuby "/home/registry/.rbenv/shims/ruby"

RailsEnv production # or staging
DocumentRoot "/home/registry/registry/public"

# Possible values include: debug, info, notice, warn, error, crit,
LogLevel info
ErrorLog "/var/log/apache2/eppback.error.log"
CustomLog "/var/log/apache2/eppback.access.log" combined

Options +FollowSymLinks -Indexes
AllowOverride None

Order allow,deny
Allow from all
Options -MultiViews -Indexes
AllowOverride all

```

Enable epp_ssl and restart apache

sudo a2ensite epp_ssl
sudo service apache2 restart

Now you should see registry admin at https://your-domain

All registry demo data can be found at:

db/seeds.rb

Initially you can use two type of users: admin users and EPP users.

For using EPP we are strongly recommend to install epp_proxy instead of mod_epp. You can get epp_proxy from https://github.com/internetee/epp_proxy

### Wkhtmltopdf setup

```
sudo apt-get install libxext-dev libxrender1 fontconfig
```

### Certificates setup

* [Certificates setup](/doc/certificates.md)

### Deployment

* [Application build and update](/doc/application_build_doc.md)

### Autotesting

* [Testing](/doc/testing.md)

### Github Actions CI

* Github Actions CI is configured to build all the PRs.

### EPP web client

Please follow EPP web client readme:

https://github.com/internetee/EPP-web-client

### WHOIS server

Please follow WHOIS server readme:

https://github.com/internetee/whois

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/internetee/registry

Awesome Lists containing this project

README