getnamingo-registry/docs/install.md

Installation

Welcome to the Installation Guide for Namingo, the comprehensive domain registry management tool. For those who prefer a streamlined setup, an automated installation process is available at https://namingo.org. We highly recommend utilizing this option for a hassle-free and efficient installation experience.

As you follow along with this document, it's important to also review the Configuration Guide. This guide will provide you with detailed information on how to configure various components of Namingo, ensuring that your system is tailored to meet your specific requirements. Familiarizing yourself with these configuration steps during installation will help in setting up Namingo for optimal performance and functionality.

Once you have completed the installation process, we encourage you to proceed to the Initial Operation Guide for detailed instructions on how to configure your registry, add registrars, and other essential operational steps.

1. Install the required packages:

apt install -y curl software-properties-common ufw
add-apt-repository ppa:ondrej/php
apt install -y debian-keyring debian-archive-keyring apt-transport-https
apt update
apt install -y bzip2 composer gettext git gnupg2 net-tools php8.2 php8.2-cli php8.2-common php8.2-curl php8.2-ds php8.2-fpm php8.2-gd php8.2-gmp php8.2-gnupg php8.2-igbinary php8.2-imap php8.2-intl php8.2-mbstring php8.2-opcache php8.2-readline php8.2-redis php8.2-soap php8.2-swoole php8.2-uuid php8.2-xml pv redis unzip wget whois

Then install the webserver you prefer:

1a. Install Caddy webserver:

curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' -o caddy-stable.gpg.key
gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg caddy-stable.gpg.key
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | tee /etc/apt/sources.list.d/caddy-stable.list
apt update
apt install -y caddy

1b. Install Nginx webserver:

add-apt-repository ppa:ondrej/nginx-mainline
apt update
apt install -y nginx python3-certbot-nginx

1c. Install Apache2 webserver:

add-apt-repository ppa:ondrej/apache2
apt update
apt install -y apache2 python3-certbot-apache

Configure time:

Make sure your server is set to UTC:

timedatectl status

If your server is not set to UTC, you can change it using the timedatectl command:

timedatectl set-timezone UTC
timedatectl status

Configure PHP:

Edit the PHP Configuration Files:

nano /etc/php/8.2/cli/php.ini
nano /etc/php/8.2/fpm/php.ini

Locate or add these lines in php.ini, also replace example.com with your registry domain name:

opcache.enable=1
opcache.enable_cli=1
opcache.jit_buffer_size=100M
opcache.jit=1255

session.cookie_secure = 1
session.cookie_httponly = 1
session.cookie_samesite = "Strict"
session.cookie_domain = example.com

In /etc/php/8.2/fpm/php.ini make one additional change.

If you have about 10000 domains, use:

memory_limit = 512M

If you have 50000 or more domains, use:

memory_limit = -1

In /etc/php/8.2/mods-available/opcache.ini make one additional change:

opcache.jit=1255
opcache.jit_buffer_size=100M

After configuring PHP, restart the service to apply changes:

systemctl restart php8.2-fpm

2. Database installation (please choose one):

2a. Install and configure MariaDB: (please use this for v1.0)

curl -o /etc/apt/keyrings/mariadb-keyring.pgp 'https://mariadb.org/mariadb_release_signing_key.pgp'

Place the following in /etc/apt/sources.list.d/mariadb.sources:

# MariaDB 10.11 repository list - created 2023-12-02 22:16 UTC
# https://mariadb.org/download/
X-Repolib-Name: MariaDB
Types: deb
# deb.mariadb.org is a dynamic mirror if your preferred mirror goes offline. See https://mariadb.org/mirrorbits/ for details.
# URIs: https://deb.mariadb.org/10.11/ubuntu
URIs: https://mirrors.chroot.ro/mariadb/repo/10.11/ubuntu
Suites: jammy
Components: main main/debug
Signed-By: /etc/apt/keyrings/mariadb-keyring.pgp

apt-get update
apt install -y mariadb-client mariadb-server php8.2-mysql
mysql_secure_installation

Tune your MariaDB

2b. Install and configure PostgreSQL: (beta!)

sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
wget -qO- https://www.postgresql.org/media/keys/ACCC4CF8.asc | tee /etc/apt/trusted.gpg.d/pgdg.asc &>/dev/null
apt update
apt install -y postgresql postgresql-client php8.2-pgsql
psql --version

Now you need to update PostgreSQL Admin User Password:

sudo -u postgres psql
postgres=#
postgres=# ALTER USER postgres PASSWORD 'demoPassword';
postgres=# CREATE DATABASE registry;
postgres=# CREATE DATABASE registryTransaction;
postgres=# CREATE DATABASE registryAudit;
postgres=# \q

Tune your PostgreSQL

2c. Database Replication Setup:

For those considering implementing replication in their Namingo installation, it is highly recommended for enhancing data availability and reliability. We have prepared a detailed guide to walk you through the replication setup process. Please refer to our comprehensive guide for setting up and managing replication by following the link: Replication Setup Guide.

2d. Database Encryption Setup:

To ensure the security and confidentiality of your data within the Namingo system, implementing database encryption is a crucial step. Database encryption helps protect sensitive information from unauthorized access and breaches. We have compiled an in-depth guide that covers the essentials of database encryption, including key management, best practices, and step-by-step instructions for secure implementation. For a thorough understanding and to begin securing your data, please refer to our detailed guide: Database Encryption Guide. This resource is designed to equip you with the knowledge and tools necessary for effectively encrypting your database in the Namingo environment.

3. Install Adminer:

mkdir /usr/share/adminer
wget "http://www.adminer.org/latest.php" -O /usr/share/adminer/latest.php
ln -s /usr/share/adminer/latest.php /usr/share/adminer/adminer.php

4. Download Namingo:

First, clone the Namingo registry repository into the /opt/registry directory:

git clone https://github.com/getnamingo/registry /opt/registry

Next, create the directory for Namingo logs. This directory will be used to store log files generated by the Namingo registry:

mkdir -p /var/log/namingo
chown -R www-data:www-data /var/log/namingo

5. Configuring UFW Firewall:

To securely set up the UFW (Uncomplicated Firewall) for your registry, follow these commands:

ufw allow 80/tcp
ufw allow 80/udp
ufw allow 443/tcp
ufw allow 443/udp
ufw allow 700/tcp
ufw allow 700/udp
ufw allow 43/tcp
ufw allow 43/udp
ufw allow 53/tcp
ufw allow 53/udp

6. Configure webserver:

6a. Caddy:

Edit /etc/caddy/Caddyfile and place the following content:

rdap.example.com {
    bind YOUR_IPV4_ADDRESS YOUR_IPV6_ADDRESS
    reverse_proxy localhost:7500
    encode gzip
    file_server
    tls your-email@example.com
    header -Server
    header * {
        Referrer-Policy "no-referrer"
        Strict-Transport-Security max-age=31536000;
        X-Content-Type-Options nosniff
        X-Frame-Options DENY
        X-XSS-Protection "1; mode=block"
        Content-Security-Policy "default-src 'none'; object-src 'none'; base-uri 'self'; frame-ancestors 'none'; img-src https:; font-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'none'; form-action 'self'; worker-src 'none'; frame-src 'none';"
        Feature-Policy "accelerometer 'none'; autoplay 'none'; camera 'none'; encrypted-media 'none'; fullscreen 'self'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; midi 'none'; payment 'none'; picture-in-picture 'self'; usb 'none';"
        Permissions-Policy: accelerometer=(), autoplay=(), camera=(), encrypted-media=(), fullscreen=(self), geolocation=(), gyroscope=(), magnetometer=(), microphone=(), midi=(), payment=(), picture-in-picture=(self), usb=();
    }
}

whois.example.com {
    bind YOUR_IPV4_ADDRESS YOUR_IPV6_ADDRESS
    root * /var/www/whois
    encode gzip
    php_fastcgi unix//run/php/php8.2-fpm.sock
    file_server
    tls your-email@example.com
    header -Server
    header * {
        Referrer-Policy "no-referrer"
        Strict-Transport-Security max-age=31536000;
        X-Content-Type-Options nosniff
        X-Frame-Options DENY
        X-XSS-Protection "1; mode=block"
        Content-Security-Policy: default-src 'none'; object-src 'none'; base-uri 'self'; frame-ancestors 'none'; img-src https:; font-src 'self'; style-src 'self' 'unsafe-inline' https://cdnjs.cloudflare.com; script-src 'none'; form-action 'self'; worker-src 'none'; frame-src 'none';
        Feature-Policy "accelerometer 'none'; autoplay 'none'; camera 'none'; encrypted-media 'none'; fullscreen 'self'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; midi 'none'; payment 'none'; picture-in-picture 'self'; usb 'none';"
        Permissions-Policy: accelerometer=(), autoplay=(), camera=(), encrypted-media=(), fullscreen=(self), geolocation=(), gyroscope=(), magnetometer=(), microphone=(), midi=(), payment=(), picture-in-picture=(self), usb=();
    }
}

cp.example.com {
    bind NEW_IPV4_ADDRESS NEW_IPV6_ADDRESS
    root * /var/www/cp/public
    php_fastcgi unix//run/php/php8.2-fpm.sock
    encode gzip
    file_server
    tls your-email@example.com
    header -Server
    log {
        output file /var/log/caddy/access.log
        format console
    }
    log {
        output file /var/log/caddy/error.log
        level ERROR
    }
    # Adminer Configuration
    route /adminer.php* {
        root * /usr/share/adminer
        php_fastcgi unix//run/php/php8.2-fpm.sock
    }
    header * {
        Referrer-Policy "same-origin"
        Strict-Transport-Security max-age=31536000;
        X-Content-Type-Options nosniff
        X-Frame-Options DENY
        X-XSS-Protection "1; mode=block"
        Content-Security-Policy: default-src 'none'; object-src 'none'; base-uri 'self'; frame-ancestors 'none'; img-src https:; font-src 'self'; style-src 'self' 'unsafe-inline' https://rsms.me; script-src 'self' 'unsafe-inline' https://cdnjs.cloudflare.com/ajax/libs/xlsx/0.18.5/; form-action 'self'; worker-src 'none'; frame-src 'none';
        Feature-Policy "accelerometer 'none'; autoplay 'none'; camera 'none'; encrypted-media 'none'; fullscreen 'self'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; midi 'none'; payment 'none'; picture-in-picture 'self'; usb 'none';"
        Permissions-Policy: accelerometer=(), autoplay=(), camera=(), encrypted-media=(), fullscreen=(self), geolocation=(), gyroscope=(), magnetometer=(), microphone=(), midi=(), payment=(), picture-in-picture=(self), usb=();
    }
}

Activate and reload Caddy:

systemctl enable caddy
systemctl restart caddy

6b. Nginx:

Move configuration files and create symbolic links:

mv /opt/registry/docs/nginx/cp.conf /etc/nginx/sites-available/
ln -s /etc/nginx/sites-available/cp.conf /etc/nginx/sites-enabled/

mv /opt/registry/docs/nginx/whois.conf /etc/nginx/sites-available/
ln -s /etc/nginx/sites-available/whois.conf /etc/nginx/sites-enabled/

mv /opt/registry/docs/nginx/rdap.conf /etc/nginx/sites-available/
ln -s /etc/nginx/sites-available/rdap.conf /etc/nginx/sites-enabled/

rm /etc/nginx/sites-enabled/default

Edit all 3 files that you just moved in /etc/nginx/sites-available, and replace server_name with the correct hostname for the service; also replace YOUR_IPV4_ADDRESS and/or YOUR_IPV6_ADDRESS accordingly.

Generate the required SSL certificates:

systemctl stop nginx
certbot --nginx -d whois.example.com -d rdap.example.com -d cp.example.com

Activate and reload Nginx:

systemctl enable nginx
systemctl restart nginx

6c. Apache2:

Move configuration files and create symbolic links:

mv /opt/registry/docs/apache2/cp.conf /etc/apache2/sites-available/
ln -s /etc/apache2/sites-available/cp.conf /etc/apache2/sites-enabled/

mv /opt/registry/docs/apache2/whois.conf /etc/apache2/sites-available/
ln -s /etc/apache2/sites-available/whois.conf /etc/apache2/sites-enabled/

mv /opt/registry/docs/apache2/rdap.conf /etc/apache2/sites-available/
ln -s /etc/apache2/sites-available/rdap.conf /etc/apache2/sites-enabled/

rm /etc/apache2/sites-enabled/000-default.conf

Edit all 3 files that you just moved in /etc/apache2/sites-available, and replace server_name with the correct hostname for the service.

Generate the required SSL certificates:

a2enmod headers proxy proxy_http proxy_fcgi setenvif rewrite
systemctl restart apache2
systemctl stop apache2
certbot --apache -d whois.example.com -d rdap.example.com -d cp.example.com

Activate and reload Apache2:

systemctl enable apache2
systemctl restart apache2

---

And now is the right time to import the provided database file(s) for your database type using Adminer.

7. Control Panel Setup:

Use a file management tool or command line to copy the entire registry/cp/ directory and place it into the web server's root directory, typically /var/www/. The target path should be /var/www/cp/.

cp -r /opt/registry/cp /var/www

Configure Environment File:

Open your command line interface and navigate to the cp (control panel) directory.

Locate the file named env-sample (/var/www/cp/env-sample) in the control panel (cp) directory.

Rename this file to .env and update the settings within this file to suit your specific environment and application needs.

Install Dependencies:

Run the following command to install the required dependencies:

composer install

This command will install the dependencies defined in your composer.json file, ensuring that your control panel has all the necessary components to operate effectively.

Install Optional Dependencies:

Execute the following command to install the optional dependencies:

composer require phpmailer/phpmailer

Creating an Admin User:

1. Navigate to the 'bin' Directory: Change to the 'bin' subdirectory where the admin user creation script is located. (create_admin_user.php)

2. Update Admin User Details: Open the script and enter the desired details for the admin user, such as email, username, and password.

3. Execute the Script: Run the script to create the admin user in your system.

4. Verify Admin Access: Attempt to log in with the new admin credentials to ensure they are functioning correctly.

5. Remove the Script: Once verified, delete the script to maintain system security.

Download TLD List:

To get the starting list of TLDs (Top-Level Domains) from ICANN and cache it for quick access later, please run the following command:

php /var/www/cp/bin/file_cache.php

Setup Cache Directory:

To setup the correct owner of the panel cache directory, please run the following command:

chown www-data:www-data /var/www/cp/cache

Setting Up Redis Session Storage:

To utilize Redis for session storage, you need to install the necessary packages and configure your environment accordingly. Follow these steps to set up Redis session storage:

cd /var/www/cp
composer require predis/predis pinga/session-redis

After installation, log out of your application if you are currently logged in. This ensures that the session starts afresh with the new configuration.

Clear your browser cookies related to the application. This step is crucial as it removes any existing session cookies that were set using the previous session storage mechanism.

Upon your next login, Redis will be used for storing session data. The new sessions will be created and managed through Redis, providing a more scalable and efficient session management system.

Note: Ensure that your Redis server is properly configured and running before proceeding with these steps. If in doubt, check with:

systemctl status redis-server

8. Setup Web Lookup:

mkdir -p /var/www/whois
cd /opt/registry/whois/web
cp -r * /var/www/whois
cd /var/www/whois/
composer require gregwar/captcha
mv config.php.dist config.php

• Configure all options in config.php.

9. Setup WHOIS:

cd /opt/registry/whois/port43
composer install
mv config.php.dist config.php

• Configure all options in config.php.

• Copy docs/whois.service to /etc/systemd/system/. Change only User and Group lines to your user and group.

systemctl daemon-reload
systemctl start whois.service
systemctl enable whois.service

After that you can manage WHOIS via systemctl as any other service.

10. Setup RDAP:

cd /opt/registry/rdap
composer install
mv config.php.dist config.php

• Configure all options in config.php.

• Copy docs/rdap.service to /etc/systemd/system/. Change only User and Group lines to your user and group.

systemctl daemon-reload
systemctl start rdap.service
systemctl enable rdap.service

After that you can manage RDAP via systemctl as any other service.

11. Setup EPP:

cd /opt/registry/epp
composer install
mv config.php.dist config.php

Configure all options in config.php.

To create test certificates (cert.pem and key.pem):

openssl genrsa -out key.pem 2048
openssl req -new -x509 -key key.pem -out cert.pem -days 365

• Copy docs/epp.service to /etc/systemd/system/. Change only User and Group lines to your user and group.

systemctl daemon-reload
systemctl start epp.service
systemctl enable epp.service

After that you can manage EPP via systemctl as any other service.

12. Setup Automation Scripts:

cd /opt/registry/automation
composer install
mv config.php.dist config.php

Configure all options in config.php.

Install Optional Dependencies:

Execute one of the following commands to install the optional dependencies:

composer require utopia-php/messaging

or

composer require phpmailer/phpmailer

This command will install one of the packages which are essential for the message broker script to function correctly.

Configuring the Message Broker

You can easily configure the message broker for email delivery in config.php. It is compatible with SendGrid, Mailgun API, and PHPMailer for those opting to use their own SMTP server. All necessary settings are conveniently located under the mailer_ lines within the file.

For establishing your own mail server, Mox, available at GitHub, provides a comprehensive solution. Install Mox following its GitHub instructions, then enter the required details in the config.php file.

To run the Message Broker, execute the following commands:

/usr/bin/php /opt/registry/automation/msg_producer.php &
/usr/bin/php /opt/registry/automation/msg_worker.php &

This will start the system and place it in the background, allowing it to run independently of your current terminal session.

Setting Up an Audit Trail Database for Namingo

To create an audit trail database for Namingo, start by editing the configuration file located at /opt/registry/automation/audit.json with the correct database details. This includes specifying the database connection parameters such as host, username, and password. Once your configuration is set up, run the command:

/opt/registry/automation/vendor/bin/audit -v audit /opt/registry/automation/audit.json

This will initialize and configure the audit trail functionality. This process ensures that all necessary tables and structures are set up in the registryAudit database, enabling comprehensive auditing of Namingo's operations.

Currently, the audit trail setup for Namingo is supported only with MySQL or MariaDB databases. If you're using PostgreSQL, you'll need to utilize an external tool for audit logging, such as pgAudit, which provides detailed audit logging capabilities tailored for PostgreSQL environments.

Setup Backup

To ensure the safety and availability of your data in Namingo, it's crucial to set up and verify automated backups. Begin by editing the backup.json file in the automation directory, where you'll input your database details. Ensure that the details for the database are accurately entered in two specified locations within the backup.json file.

Additionally, check that the cronjob for PHPBU is correctly scheduled on your server, as this automates the backup process. You can verify this by reviewing your server's cronjob list. These steps are vital to maintain regular, secure backups of your system, safeguarding against data loss and ensuring business continuity.

RDE (Registry data escrow) configuration:

Generate the Key Pair:

Create a configuration file, say key-config, with the following content:

%echo Generating a default key
Key-Type: RSA
Key-Length: 2048
Subkey-Type: RSA
Subkey-Length: 2048
Name-Real: Your Name
Name-Comment: Your Comment
Name-Email: your.email@example.com
Expire-Date: 0
%no-protection
%commit
%echo done

Replace "Your Name", "Your Comment", and "your.email@example.com" with your details.

Use the following command to generate the key:

gpg2 --batch --generate-key key-config

Your GPG key pair will now be generated.

Exporting Your Keys:

Public key:

gpg2 --armor --export your.email@example.com > publickey.asc

Replace your-email@example.com with the email address you used when generating the key.

Private key:

gpg2 --armor --export-secret-keys your.email@example.com > privatekey.asc

Secure Your Private Key:

Always keep your private key secure. Do not share it. If someone gains access to your private key, they can impersonate you in cryptographic operations.

Use in RDE deposit generation:

Please send the exported publickey.asc to your RDE provider, and also place the path to privatekey.asc in the escrow.php system as required.

Running the Automation System

Once you have successfully configured all automation scripts, you are ready to initiate the automation system. Please review /opt/registry/automation/cron.php and enable all services if you are running a gTLD. Then proceed by adding the following cron job to the system crontab using crontab -e:

* * * * * /usr/bin/php8.2 /opt/registry/automation/cron.php 1>> /dev/null 2>&1

13. Setup DAS:

cd /opt/registry/das
composer install
mv config.php.dist config.php

Configure all options in config.php.

• Copy docs/das.service to /etc/systemd/system/. Change only User and Group lines to your user and group.

systemctl daemon-reload
systemctl start das.service
systemctl enable das.service

After that you can manage DAS via systemctl as any other service.

14. Setup Hidden Master DNS with BIND:

Although Namingo is equipped with BIND by default for this purpose, you can opt for NSD, or Knot DNS if you are more comfortable with those systems.

Install BIND9 and its utilities with:

apt install bind9 bind9-utils bind9-doc

Generate a TSIG key:

Generate a TSIG key which will be used to authenticate DNS updates between the master and slave servers. Note: replace test with your TLD.

cd /etc/bind
tsig-keygen -a HMAC-SHA256 test.key

The output will be in the format that can be directly included in your BIND configuration files. It looks something like this:

key "test.key" {
    algorithm hmac-sha256;
    secret "base64-encoded-secret==";
};

Copy this output for use in the configuration files of both the master and slave DNS servers. (/etc/bind/named.conf.local)

Configure the Named Configuration File (Please Choose One):

1. Without DNSSEC:

Edit the named.conf.local file:

nano /etc/bind/named.conf.local

Add the following zone definition:

zone "test." {
    type master;
    file "/var/lib/bind/test.zone";
    allow-transfer { key "test.key"; };
    also-notify { <slave-server-IP>; };
};

Replace <slave-server-IP> with the actual IP address of your slave server. Replace test with your TLD.

Use rndc to reload BIND:

systemctl restart bind9

Configure the Zone Writer in Registry Automation and run it manually the first time.

php /opt/registry/automation/write-zone.php

2. Using DNSSEC with BIND9:

Edit the named.conf.local file:

nano /etc/bind/named.conf.local

Add the following DNSSEC policy:

dnssec-policy "namingo-policy" {
    keys {
        ksk lifetime P3M algorithm ed25519;
        zsk lifetime P1M algorithm ed25519;
    };
    max-zone-ttl 86400;
    dnskey-ttl 3600;
    zone-propagation-delay 3600;
    parent-propagation-delay 7200;
    parent-ds-ttl 86400;
};

Add the following zone definition:

zone "test." {
    type master;
    file "/var/lib/bind/test.zone";
    dnssec-policy "namingo-policy";
    key-directory "/var/lib/bind";
    inline-signing yes;
    allow-transfer { key "test.key"; };
    also-notify { <slave-server-IP>; };
};

Replace <slave-server-IP> with the actual IP address of your slave server. Replace test with your TLD.

Initially, you will need to generate the DNSSEC ZSK and KSK manually:

dnssec-keygen -a Ed25519 -n ZONE test.
dnssec-keygen -a Ed25519 -n ZONE -f KSK test.

After generating the keys, place them in /var/lib/bind. Run dnssec-dsfromkey Ktest.EXAMPLE.key on the KSK key you just generated, and the DS record must be submitted to IANA once setup is complete.

Use rndc to tell BIND to load and use the new keys:

systemctl restart bind9
rndc loadkeys test.

Configure the Zone Writer in Registry Automation and run it manually the first time.

php /opt/registry/automation/write-zone.php

3. Using DNSSEC with OpenDNSSEC:

Edit the named.conf.local file:

nano /etc/bind/named.conf.local

Add the following zone definition:

zone "test." {
    type master;
    file "/var/lib/bind/test.zone.signed";
    allow-transfer { key "test.key"; };
    also-notify { <slave-server-IP>; };
};

Replace <slave-server-IP> with the actual IP address of your slave server. Replace test with your TLD.

Install OpenDNSSEC:

apt install opendnssec opendnssec-enforcer-sqlite3 opendnssec-signer softhsm2

Update files in /etc/opendnssec to match your registry policy. As minimum, please enable at least Signer Threads in /etc/opendnssec/conf.xml, but we recommend to fully review all the files. Then run the following commands:

softhsm2-util --init-token --slot 0 --label OpenDNSSEC --pin 1234 --so-pin 1234
ods-enforcer-db-setup
rm /etc/opendnssec/prevent-startup
ods-control start
ods-enforcer policy import
ods-enforcer zone add -z test -p default -i /var/lib/bind/test.zone

Use rndc to reload BIND:

systemctl restart bind9

Configure the Zone Writer in Registry Automation and run it manually the first time.

php /opt/registry/automation/write-zone.php

Check BIND9 Configuration:

named-checkconf
named-checkzone test /var/lib/bind/test.zone

Restart BIND9 Service:

systemctl restart bind9

Verify Zone Loading:

Check the BIND9 logs to ensure that the .test zone is loaded without errors:

grep named /var/log/syslog

14.1 Regular DNS Server Setup:

Before editing the configuration files, you need to copy the TSIG key from your hidden master server. The TSIG key configuration should look like this:

key "test.key" {
    algorithm hmac-sha256;
    secret "base64-encoded-secret==";
};

Installation of BIND9:

apt update
apt install bind9 bind9-utils bind9-doc

Add the TSIG key to the BIND Configuration:

Create a directory to store zone files:

mkdir /var/cache/bind/zones

Edit the named.conf.local file:

nano /etc/bind/named.conf.local

First, define the TSIG key at the top of the file:

key "test.key" {
    algorithm hmac-sha256;
    secret "base64-encoded-secret=="; // Replace with your actual base64-encoded key
};

Then, add the slave zone configuration:

zone "test." {
    type slave;
    file "/var/cache/bind/zones/test.zone";
    masters { 192.0.2.1 key "test.key"; }; // IP of the hidden master and TSIG key reference
    allow-query { any; }; // Allow queries from all IPs
    allow-transfer { none; }; // Disable zone transfers (AXFR) to others
};

Make sure to replace 192.0.2.1 with the IP address of your hidden master server and base64-encoded-secret== with the actual secret from your TSIG key.

Adjusting Permissions and Ownership:

Ensure BIND has permission to write to the zone file and that the files are owned by the BIND user:

chown bind:bind /var/cache/bind/zones
chmod 755 /var/cache/bind/zones

Restart BIND9 Service:

After making these changes, restart the BIND9 service to apply them:

systemctl restart bind9

Verify Configuration and Zone Transfer:

named-checkconf
grep 'transfer of "test."' /var/log/syslog

15. Setup Monitoring:

For effective monitoring of your registry system, we highly recommend utilizing Prometheus.

wget https://github.com/prometheus/prometheus/releases/download/v2.48.1/prometheus-2.48.1.linux-amd64.tar.gz
tar xvfz prometheus-2.48.1.linux-amd64.tar.gz
cp prometheus-2.48.1.linux-amd64/prometheus /usr/local/bin/
cp prometheus-2.48.1.linux-amd64/promtool /usr/local/bin/
useradd --no-create-home --shell /bin/false prometheus
mkdir /etc/prometheus
mkdir /var/lib/prometheus
cp -r prometheus-2.48.1.linux-amd64/consoles /etc/prometheus
cp -r prometheus-2.48.1.linux-amd64/console_libraries /etc/prometheus
chown -R prometheus:prometheus /etc/prometheus
chown -R prometheus:prometheus /var/lib/prometheus

Place the following in the /etc/prometheus/prometheus.yml and customize as needed:

# Global settings and defaults.
global:
  scrape_interval: 15s  # By default, scrape targets every 15 seconds.
  evaluation_interval: 15s  # Evaluate rules every 15 seconds.

# Alertmanager configuration (commented out by default).
# alerting:
#   alertmanagers:
#   - static_configs:
#     - targets:
#       - localhost:9093

# Load and evaluate rules in this file.
# rule_files:
#   - "first_rules.yml"
#   - "second_rules.yml"

# Scrape configuration for running Prometheus on the same machine.
scrape_configs:
  # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
  - job_name: 'prometheus'
    # metrics_path defaults to '/metrics'
    # scheme defaults to 'http'.
    static_configs:
      - targets: ['localhost:9090']

  # Example job for scraping an HTTP service.
  - job_name: 'http_service'
    static_configs:
      - targets: ['<your_http_service>:80']

  # Example job for scraping an HTTPS service.
  - job_name: 'https_service'
    static_configs:
      - targets: ['<your_https_service>:443']

  # Example job for scraping a DNS server.
  - job_name: 'dns_monitoring'
    static_configs:
      - targets: ['<your_dns_server>:53']

# Add additional jobs as needed for your services.

Run the monitoring tool using:

prometheus --config.file=/etc/prometheus/prometheus.yml

The tool will be available at http://<your_server_ip>:9090

16. Recommended Help Desk Solution:

If you're in need of an effective help desk solution to complement your experience with Namingo, we recommend considering FreeScout, an AGPL-3.0 licensed, free and open-source software. FreeScout is known for its user-friendly interface and robust features, making it an excellent choice for managing customer queries and support tickets.

Please Note:

• FreeScout is an independent software and is not a part of Namingo. It is licensed under the AGPL-3.0, which is different from Namingo's MIT license.
• The recommendation to use FreeScout is entirely optional and for the convenience of Namingo users. Namingo functions independently of FreeScout and does not require FreeScout for its operation.
• Ensure to comply with the AGPL-3.0 license terms if you choose to use FreeScout alongside Namingo.