1.2. Installation on Ubuntu¶

Caution

This section is currently under construction. If you run into any issues, please contact us at fred@nic.cz

1.2.1. FRED demo¶

For testing and demonstration purposes we provide a virtual image of Ubuntu server with uninitialized instance of FRED. Download the image here
Use VirtualBox for best results. You can convert the image to work with Gnome-boxes using the following command:
```
qemu-img convert -p -f vmdk -O qcow2 box-disk001.vmdk box-disk001.qcow2
```
After importing, you can launch the server and ssh into the machine with user: vagrant, password: vagrant.
After successfully logging in, restart all registry services via command:
```
sudo systemctl restart 'fred-*'
```
Important

Registry itself is not initialized! Before you start working with FRED, you need to take steps described in the chapter registry initialization.
The registry is ready to use. You can find the following services running on these locations:
- Browser:
  
  FERDA – web based administration interface: https://localhost:4443 login admin / password
  
  Secretary – django admin app for editing mail templates: https://localhost:8090 login admin / password
  
  WebWHOIS – simple website for searching domains using whois protocol: https://localhost:4444
- Protocols:
  
  EPP http://localhost:700
  
  WHOIS https://localhost:4444
  
  RDAP https://localhost:4445
- CLI Tools:
  
  /usr/sbin/fred-admin – Administrate the registry, registrars and customise pricing (some of these actions are also available in more user friendly FERDA administration interface)
  
  /usr/bin/fred-client – A Python EPP client for registrars to allow administration registry objects without having to write their own implementation of EPP
  
  C++ and python daemons as described here
- Databases: To access the db cluster switch to user postgres using sudo su - postgres and running psql
Note

Please note that for full functionality you should configure periodic tasks, as described in chapter periodic tasks.

1.2.2. Installation steps¶

This section explains some of the the individual steps that are taken by the installation script to install software required for the operation of FRED. For more details check the script, which contains comments on all actions taken.

Switch to root before you begin

sudo su -

1.2.2.1. Prerequisites¶

Install dependencies

apt update
apt install -y ca-certificates curl gnupg lsb-release python3-dnspython

Docker installation

sudo mkdir -m 0755 -p /etc/apt/keyrings

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --batch --yes --dearmor -o /etc/apt/keyrings/docker.gpg

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

apt update
apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Create dummy network interface for docker

cat << EOT >> /etc/netplan/01-dock.yaml
network:
  version: 2
  renderer: networkd
  bridges:
    dock:
      dhcp4: false
      dhcp6: false
      accept-ra: false
      interfaces: [ ]
      addresses:
        - 192.168.1.1/32
EOT

netplan apply

Add cznic keyring for fred packages and run update with the new source list

mkdir -p /usr/share/keyrings/
wget https://archive.nic.cz/dists/cznic-archive-keyring.gpg --output-document=/usr/share/keyrings/cznic-archive-keyring.gpg

cat << EOT >> /etc/apt/sources.list.d/fred.list
deb [signed-by=/usr/share/keyrings/cznic-archive-keyring.gpg] http://archive.nic.cz/public $(lsb_release -sc) main
EOT

apt update

Postfix non-interactive installation

debconf-set-selections <<< "postfix postfix/mailname string $(hostname)"
debconf-set-selections <<< "postfix postfix/main_mailer_type string 'Internet Site'"
apt --assume-yes install postfix

1.2.2.2. FRED installation¶

Installation of FRED backend services (using meta package)
```
apt --assume-yes install fred
```

Set the PostgreSQL timezone to UTC

sed -i~ -e "s/^#\?\s*timezone\s*=.*/timezone = 'UTC'/" /etc/postgresql/12/main/postgresql.conf
systemctl restart postgresql

Initialization of the FRED database (schemas)

su - postgres -c "/usr/sbin/fred-dbmanager install"

Add system registrar, otherwise some of the services wont start

/usr/sbin/fred-admin --registrar_add --handle=REG-SYSTEM --reg_name=REG-SYSTEM --organization=SYSTEM --street1=SYSTEM --city=SYSTEM --email=SYSTEM --url=SYSTEM --country=CZ --dic=12345 --no_vat --system

Configuration of fred-backend-registry` and fred-backend-logger – for detail see the installation script
Configuration of FRED messenger – for detail see the installation script

Create and initialize FRED messenger database

sudo -u postgres psql -c 'CREATE DATABASE messenger;'
sudo -u postgres psql -c "CREATE USER messenger WITH ENCRYPTED PASSWORD 'passwd';"
sudo -u postgres psql -c 'GRANT ALL PRIVILEGES ON DATABASE messenger TO messenger;'
MESSENGER_CONFIG=/etc/fred/messenger.conf alembic --config /etc/fred/messenger-alembic.ini upgrade head

Enable secretary in uWSGI

cp /usr/share/doc/python3-django-secretary/examples/fred-secretary.ini /etc/uwsgi/apps-available/
ln -s /etc/uwsgi/apps-available/fred-secretary.ini /etc/uwsgi/apps-enabled/fred-secretary.ini
sed -i '/\/run\/uwsgi\/fred-secretary\/socket/c\socket = \/run\/uwsgi\/app\/fred-secretary\/socket' /etc/uwsgi/apps-available/fred-secretary.ini
cp /usr/share/doc/python3-django-secretary/examples/uwsgi_secretary.py /etc/uwsgi/

Setup nginx and copy secretary configuration

apt --assume-yes install nginx
cp /usr/share/doc/python3-django-secretary/examples/secretary-nginx.conf /etc/nginx/sites-available/secretary.conf
ln -s /etc/nginx/sites-available/secretary.conf /etc/nginx/sites-enabled/secretary.conf
rm /etc/nginx/sites-enabled/default

Create a folder for the uWSGI socket and static files folder for secretary

mkdir -p /run/uwsgi/app/fred-secretary/
chown www-data:www-data /run/uwsgi/app/fred-secretary
mkdir -p /var/www/fred/
chown www-data:www-data /var/www/fred

Create and initialize secretary database

sudo -u postgres psql -c 'CREATE DATABASE secretary;'
sudo -u postgres psql -c "CREATE USER secretary WITH ENCRYPTED PASSWORD 'passwd';"
sudo -u postgres psql -c 'GRANT ALL PRIVILEGES ON DATABASE secretary TO secretary;'
sudo -u www-data PYTHONPATH=/etc/fred DJANGO_SETTINGS_MODULE=secretary_cfg.settings django-admin migrate

Collect secretary static files and create secretary superuser

sudo -u www-data PYTHONPATH=/etc/fred DJANGO_SETTINGS_MODULE=secretary_cfg.settings django-admin collectstatic
sudo -u www-data DJANGO_SUPERUSER_USERNAME=admin DJANGO_SUPERUSER_PASSWORD=password DJANGO_SUPERUSER_EMAIL=admin@admin.com PYTHONPATH=/etc/fred DJANGO_SETTINGS_MODULE=secretary_cfg.settings django-admin createsuperuser --noinput

Load secretary templates

apt install python3-docopt
cd /usr/share/doc/python3-django-secretary/examples/secretary-templates/
sudo -u www-data PYTHONPATH=/etc/fred DJANGO_SETTINGS_MODULE=secretary_cfg.settings python3 load_templates.py pdf-templates.yml
sudo -u www-data PYTHONPATH=/etc/fred DJANGO_SETTINGS_MODULE=secretary_cfg.settings python3 load_templates.py fred-migration.yml
sudo -u www-data PYTHONPATH=/etc/fred DJANGO_SETTINGS_MODULE=secretary_cfg.settings python3 load_templates.py fred-templates.yml

Enable installed services and start them

systemctl enable --now omniorb4-nameserver fred-accifd fred-adifd fred-akmd fred-backend-logger fred-backend-registry fred-dbifd fred-logd fred-msgd fred-pifd fred-rifd fred-rsifd fred-pyfred fred-webadmin fred-secretary fred-messenger-server apache2 nginx

Allow epp and whois daemon in apache

a2ensite 02-fred-mod-eppd-apache.conf
a2ensite 02-fred-mod-whoisd-apache.conf
service apache2 restart

Restart the nginx and services to be sure, that the config is correctly loaded

systemctl restart nginx
systemctl restart 'fred-*'
systemctl restart omniorb4-nameserver

Deploy docker apps – Ferda, Webwhois, RDAP

apps=("ferda" "webwhois" "rdap")
WORKDIR=/etc/fred/docker-apps/
# Initialize new docker swarm so we can have docker stack for each service
docker swarm init --advertise-addr 127.0.0.1

mkdir -p $WORKDIR
# We are doing the same process for every docker app - pull demo compose and .env file, pull images and deploy them using docker stack
for app in ${apps[@]}; do
      # Create directory structure for docker-apps and download demo-deploy files
      mkdir $WORKDIR/$app-git
      cd $WORKDIR/$app-git
      git clone https://gitlab.nic.cz/fred/$app
      cd ..
      mkdir -p $WORKDIR/$app
      cp -r $app-git/$app/docs/demo-deploy $app
      rm -rf $app-git

      # Pull app images from registry.nic.cz
      docker pull registry.nic.cz/fred/$app/$app-uwsgi
      docker pull registry.nic.cz/fred/$app/$app-nginx

      # Deploy docker stacks
      cd $WORKDIR/$app/demo-deploy/
      docker stack deploy --compose-file docker-compose.yml $app
done

Before starting FRED for the first time, set the timezone in PostgreSQL to your location (FRED demo script sets it automatically to UTC)
Initialize the system – instructions how to do it can be found in the chapter System initialization