Installation

This page describes the installation procedure of the Web Interface and the GDS back-end.

Both, the back-end and the web interface, are integrated into the SeisComP environment. The following tables shows the location of the GDS bundle:

Location

Description

$SEISCOMP_ROOT/bin/gds

Binary of the back-end server

$SEISCOMP_ROOT/bin/quakelink

Binary of the QuakeLink server

$SEISCOMP_ROOT/share/gds/tools

Python framework for content filter and spooler scripts as well as sample implementations

$SEISCOMP_ROOT/share/gds/web

Base directory of the Web Interface

Requirements

The GDS relies on the following packages:

Dependency

Required by

Python >= 3.6

web interface

Python >= 2.7

back-end

Django = 3.2.*

web interface

Django-Bitfield

web interface

Django-Extensions

web interface (optional)

Django-SimpleHistory = 3.0.*

web interface

MySQL or PostgreSQL server

back-end, web interface

Python3 MySQL (2.0.1) or PostgreSQL interface

web interface

psycopg2 2.5.4 (PostgreSQL only)

web interface

NGINX web server including Gunicorn

web interface (optional)

QuakeLink Server

back-end, web interface

The installation of a web server is optional since Django ships with a tiny build-in web server. This build-in server is sufficient for testing purposes and if the GDS should be configured respectively monitored only locally (same machine). To use the full potential of the web configuration approach, the integration into an NGINX web server is recommended.

Note

In addition to the dependencies listed above more packages are required by the SeisComP environment. Please refer to the SeisComP manual. Since SeisComP version Seattle dependencies may be installed via seiscomp install-deps. Issue seiscomp help install-deps for a list of available packages. Furthermore you might want to use the same database management system for the GDS database as used by the SeisComP messaging system to safe computational resources.

Ubuntu/Debian

Installation of Python3 and the package installer for Python (PIP).

sudo apt-get install python3 python3-pip

Database

Install one of the following database management systems (DBMS):

For production environments it is also recommended to install the NGINX web server.

MariaDB
sudo apt-get install mariadb-server mariadb-client libmariadbclient-dev
python3 -m pip install --user mysqlclient
MySQL
sudo apt-get install mysql-server mysql-client libmysqlclient-dev
python3 -m pip install --user mysqlclient
PostgreSQL
apt-get install postgresql postgresql-client
python3 -m pip install --user psycopg2-binary

NGINX

sudo apt-get install nginx

Gunicorn

python3 -m pip install --user gunicorn

RHEL

Installation of the Python3 and the package installer for Python (PIP).

su -
yum install python3 python3-pip
exit

Database

Install one of the following database management systems (DBMS):

For production environments it is also recommended to install the NGINX web server.

MariaDB
su -
yum install mariadb mariadb-server mariadb-devel gcc python3-devel
exit
python3 -m pip install --user mysqlclient
PostgreSQL
su -
yum install postgresql postgresql-client
exit
python3 -m pip install --user psycopg2-binary

NGINX

su -
yum install nginx
exit

Gunicorn

python3 -m pip install --user gunicorn

Django

The Web Interface requires the Django framework as well as the django-bitfield module. Although most distributions offer Django packages, it is highly recommended to use the particular Django version 3.2.

To supply the web interface with the required libraries, the Django framework and the bitfield module must be installed. The django-extension package is optional. It provides command line tools, e.g., for template debugging and secret key generation.

python3 -m pip install --user django==3.2.*
python3 -m pip install --user django-bitfield
python3 -m pip install --user django-extensions
python3 -m pip install --user django-simple-history==3.0.*

Web Interface

Database Initialization

The GDS database must be created and permissions have to be granted to a user.

MariaDB/MySQL

mysql -h localhost -u root -p
mysql> CREATE DATABASE gds CHARACTER SET utf8mb4;
mysql> GRANT USAGE ON gds.* TO sysop@localhost IDENTIFIED BY 'sysop';
mysql> GRANT ALL PRIVILEGES ON gds.* TO sysop@localhost;

If the MySQL server resides on a different machine, the localhost must be replaced by the server’s IP. Also the database name, user and password may need to be modified.

Django requires MySQL timezone information. Issue the following command to check if your MySQL database is timezone aware:

mysql> SELECT CONVERT_TZ(now(), 'UTC','Europe/Berlin');

If the result is NULL you need to populate your DBMS with timezone information:

mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -D mysql -u root -p
mysql -u root -p -e "FLUSH TABLES;" mysql

The GDS offers to log the full bulletin content in the database. Depending on the messages you plan to send and on the operating system you use the default maximum allowed database packet size might be to small. Use the following commands to review the current settings of your DBMS:

mysql -h localhost -u root -p
mysql> SHOW VARIABLES LIKE 'max_allowed_packet';

If you think you will hit this limit you need to increase the packet size value in your DB server configuration. E.g., for RHEL and MariaDB this is done in the /etc/my.cnf.d/server.cnf:

[mariadb]
max_allowed_packet = 16777216

PostgreSQL

sudo -u postgres -i
createuser -P -d sysop
   Enter password for new role:
   Enter it again:
   Shall the new role be a superuser? (y/n) n
   Shall the new role be allowed to create more new roles? (y/n) n
createdb -O sysop gds
exit

Create and Adjust Settings

The web interface ships with 2 example configuration files. Change to the front-end directory and create a copy of those files.

cd $SEISCOMP_ROOT/share/gds/web/gds
cp example-settings.py settings.py
cp example-settings-production.py settings-production.py

The $SEISCOMP_ROOT/share/gds/web/gds/settings.py holds the main configuration settings. Although the defaults in place will work for most installations it is a good practice to review them. Especially the connection settings for the database as well as the GDS and QuakeLink server should be checked.

The $SEISCOMP_ROOT/share/gds/web/gds/settings-production.py extends the default settings by options needed for a production environment using a reverse proxy, see Web Server Integration. Typically one may change the value of

  • FORCE_SCRIPT_NAME if you a are deploying the GDS on a sub-path other than /gds.

  • ALLOWED_HOSTS which must include all IPs and hostnames you will use to access the GDS web interface.

Note: The Django build-in web server is considered to be insecure and should not be exposed to the public. You may use it in production if your network is properly shielded.

Completing the Installation

The database must be initialized with the Django admin tables and the GDS model. Also a Django super user must be created to login to the web interface. The 3rd command (loaddata) is optional. It will create an example configuration containing an email service, a queue matching for all world-wide events and finally a subscription to this queue. The 4th command (collectstatic) is only needed for the production environment. It copies all static files into a single directory (STATIC_ROOT) which needs to be served by NGINX. The last command (generate_secret_key) generates a secret key used in production.

cd $SEISCOMP_ROOT/share/gds/web
python3 manage.py migrate
python3 manage.py createsuperuser
python3 manage.py loaddata sample-data.json
python3 manage.py collectstatic
python3 manage.py generate_secret_key > gds/secretkey.txt

To test the configuration the Django build-in web server may be started:

cd $SEISCOMP_ROOT/share/gds/web
python3 manage.py runserver

By default the server is available under http://localhost:8000

Note: The Django build-in web server is considered to be insecure and should not be exposed to the public. You may use it in production if your network is properly shielded.

To run the Django build-in server with production settings and to serve on all network interfaces issue the following command:

cd $SEISCOMP_ROOT/share/gds/web
python3 manage.py runserver --settings=gds.settings-production 0.0.0.0:8000

Web Server Integration

If you verified that the build-in web server is running, you may stop it now (Ctrl+C) and continue with integration into the NGINX <sec-inst-web-nginx> web server.

NGINX

NGINX relies on an external WSGI service to map HTTP requests to the Django web application. The communication between NGINX and the WSGI service will be realized through a unix socket, although TCP based deployments are possible, e.g, if both processes should run on different machines.

The WSGI service will run under the same user under which Django is installed. The configuration examples use the default SeisComP user sysop for this purpose.

In addition to the WSGI service, the NGINX server will serve static files from STATIC_ROOT typically configured to /usr/share/nginx/html/gds/static.

TODO:

sudo mkdir -p /usr/share/nginx/html/gds/static
sudo chown sysop:sysop /usr/share/nginx/html/gds/static

Gunicorn

  • Copy the relevant parts of the server and upstream directive from $SEISCOMP_ROOT/share/gds/web/examples/nginx-gunicorn.conf to your

    • /etc/nginx/nginx.conf or

    • /etc/nginx/sites-available/YOUR-VHOST.conf in case you are using a virtual host setup

    If you are deploying the GDS on a path other than /gds, adjust the location directives accordingly. Make sure the sub-path matches the FORCE_SCRIPT_NAME variable in your $SEISCOMP_ROOT/share/gds/web/gds/settings-production.py.

  • Copy the Gunicorn configuration file to the Django base directory:

    cd $SEISCOMP_ROOT/share/gds/web/
cp examples/gunicorn/gunicorn.conf.py .

    Adjust the configuration, e.g., logging level, path and format if necessary.

  • Copy the Gunicorn socket and service systemd configuration:

    sudo cp $SEISCOMP_ROOT/share/gds/web/examples/gunicorn/gunicorn-gds.* /etc/systemd/system

    Adjust the user, group, or WorkingDirectory variables if necessary. Then enable and start the service:

    sudo systemctl enable gunicorn-gds
sudo systemctl start gunicorn-gds

  • Test the NGINX configuration:

    sudo nginx -t

  • Enable and start NGINX:

    sudo systemctl enable nginx
sudo systemctl start nginx

  • Trouble shooting

    • Check if the socket file /var/run/gunicorn-gds.sock was created and ensure that the NGINX user (nginx or www-data) has write access to this file

    • Make a request directly at the socket:

      sudo -u nginx curl --unix-socket /var/run/gunicorn-gds.sock -H "SCRIPT_NAME: /gds" http

    • By default Gunicorn logs to $HOME/.seiscomp/log/gds-web/access,error.log

    • Reload gunicorn-gds service after modifications to your $SEISCOMP_ROOT/share/gds/web/gunicorn.conf.py or Django configuration file: sudo systemctl reload gunicorn-gds

    • Reload systemd configuration after modifications to systemd service and socket files: sudo systemctl daemon-reload

    • Reload the NGINX server configuration: sudo nginx -t && sudo systemctl reload nginx

Next Steps

  • Login using the administrator account you created

  • Create staff users with some/all privileges prefix by gds_

  • Create Services, Queues and Subscriptions

  • Configure (re)start the Back-end

Back-end

The GDS back-end server is integrated into the SeisComP environment and is started like every other SeisComP application. Before running the server, the database must be created and initialized.

For each Services, External Criteria and Filters a corresponding entry in the servers configuration file must exist.

Update Instructions

If you already operate a GDS version and you intent to install an update you should:

  • read the CHANGELOG file to get an overview of the changes

  • consider creating a database backup

  • extract the bundle (overriding existing files in the installation folder)

  • check for new or updated parameters in the $SEISCOMP_ROOT/share/gds/web/gds/example-settings.py and $SEISCOMP_ROOT/share/gds/web/gds/example-settings-production.py configuration files and apply them to your copies

  • apply database migrations if needed

  • remove and collect static files again

  • restart the GDS server and (optionally) the reverse proxy server

Migration to 2021.294 (Django 3.2, simple-history)

With version 2021.294 the GDS front-end switched from Django 3.1 to the LTS version 3.2. Also history support for the data model has been added allowing to review all changes to a particular configuration object and to revert back to a previous revision.

Python dependencies

Update Django and install the SimpleHistory django plugin:

python3 -m pip install --user django==3.2.*
python3 -m pip install --user django-simple-history==3.0.*

Update of configuration files

Compare your $SEISCOMP_ROOT/share/gds/web/gds/settings.py with the updated $SEISCOMP_ROOT/share/gds/web/gds/example-settings.py. Especially make sure to

  • add the line DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'

  • add 'simple_history', to the INSTALLED_APPS list

  • add 'simple_history.middleware.HistoryRequestMiddleware', to the MIDDLEWARE list

Compare your $SEISCOMP_ROOT/share/gds/web/gds/settings-production.py with the updated $SEISCOMP_ROOT/share/gds/web/gds/example-settings-production.py. Especially make sure to

  • add 'simple_history', to the INSTALLED_APPS list

Database migrations

The data model changed. To complete the update run:

cd $SEISCOMP_ROOT/share/gds/web
python3 manage.py migrate
python3 manage.py populate_history --auto

Static files

The static files changed and need to be collected again:

cd $SEISCOMP_ROOT/share/gds/web
rm -rf static
python3 manage.py collectstatic

Migration to 2020.282 (Django 3.1)

With version 2020.282 the GDS front-end switched from Django 1.11 to 3.1 and requires a minimum Python version of 3.6. The back-end was updated to support Python 3 but continues to support Python 2 starting from version 2.7 in order to support SeisComP3 Jakarta 2018.327 and older.

Cleanup

Since this is a major update it is recommended to move your $SEISCOMP_ROOT/share/gds/web/ folder to a temporary location prior to the installation of the new GDS package and later on to restore your $SEISCOMP_ROOT/share/gds/web/gds/settings.py and $SEISCOMP_ROOT/share/gds/web/gds/settings-production.py while merging the new configuration options found in the $SEISCOMP_ROOT/share/gds/web/gds/example-settings* files . If you do not want to move your web folder or if you already extracted the GDS package then please remove at least the following files:

rm -rf $SEISCOMP_ROOT/share/gds/web/{django,django_extensions,bitfield}
rm $SEISCOMP_ROOT/share/gds/web/gds/templatetags/breadcrumbs.py

Additional Dependencies

The following new dependencies have been introduced:

  • Python >=3.6

  • django-3.1

Please refer to Django and Ubuntu/Debian respectively RHEL for installation instructions.

Back-end Configuration

In contrast to previous GDS versions the MIME type of a filter is no longer guessed but must be specified in the GDS back-end configuration, see

Common MIME types are

  • text/gds - GDS bulletin format used by most of the sample filter scripts shipped with GDS

  • text/x-python - Python dictionary displayed as key-value pairs

  • image/[subtype] - Images of any type

  • text/[subtype] - Generic text

  • application/pdf - PDF document

Filter and Spooler Library

The GDS Python library ($SEISCOMP_ROOT/share/gds/tools) uses the seiscomp-python shebang to determine the Python version the SeisComP Python bindings are compiled for. For SeisComP versions <= 2018.327 an alias pointing to either python2 or python3 needs to be created. When the GDS is installed via gsm this will be done automatically. It is recommended to use the same shebang in custom filter and spooler scripts.

Furhter noteable changes are:

  • renamed $SEISCOMP_ROOT/share/gds/tools/lib/xml.py to $SEISCOMP_ROOT/share/gds/tools/lib/scml.py to avoid naming conflicts

  • logging facility

    • new messageLimit configuration parameter

    • try to read log directory from SeisComP Environment, use $HOME/.seiscomp/log as fallback

Database Migrations after 2017.269

Starting with version 2017.269 the GDS front-end switched from Django 1.4 to 1.11.15. The new Django version provides build-in database migration mechanism.

To list applied and outstanding migrations issue:

cd $SEISCOMP_ROOT/share/gds/web
python3 manage.py showmigrations

To apply outstanding migrations run:

python3 manage.py migrate

Migration to 2017.269 (Django 1.11.15)

With version 2017.269 the GDS front-end switched from Django 1.4 to 1.11.15 special attention must be giving to this update.

Additional Dependencies

The following new dependencies have been introduced:

  • Python >=2.7

  • pytz

  • django-1.11.15

  • django-extensions (optional)

  • django-bitfield

Refer to Django and Ubuntu/Debian respectively RHEL for installation instructions.

Database

If you are updating from a GDS version older than 2017.079 make sure to run all appropriate database update scripts to be found in migrations/pre-2017.269

cd $SEISCOMP_ROOT/share/gds/web/gds/migrations/pre-2017.269/mysql
mysql -u sysop -p gds < 2016....
mysql -u sysop -p gds < 2017.079

Although the GDS datamodel was not changed between 2017.079 and 2017.269 you still need to be migrate your database to update the Django system tables. Since your system tables already have been initialized the initial migration step needs to be skipped:

cd $SEISCOMP_ROOT/share/gds/web
python3 manage.py migrate --fake-initial

New Directory Structure

  • all GDS related files are located under the gds subfolder

  • templates moved from contrib to templates folder

  • CSS and java script files moved from media to static folder, no need to serve media directory with NGINX anymore

Database Backup and Restore

It is a good idea create database backups on regular basis. Especially before upgrading to a newer GDS version a backup is recommended.

MariaDB/MySQL

Backup

Create a backup of the entire GDS database:

mysqldump -u sysop -p gds > /tmp/gds.sql

Create a backup of the GDS database but omit the rather large GDS log tables:

mysqldump -u sysop -p gds --no-data db_name > /tmp/gds.sql
mysqldump -u sysop -p gds --no-create-info --ignore-table=gds_log_event --ignore-table=gds_log_service --ignore-table=gds_log_recv >> /tmp/gds.sql

Restore

mysql -u sysop -p gds < /tmp/gds.sql

PostgreSQL

Backup

Create a backup of the entire GDS database:

pg_dump -U sysop -W -F c gds > /tmp/gds.sql

Create a backup of the GDS database but omit the rather large GDS log tables:

pg_dump -U sysop -W -F c --exclude-table-data=gds_log_* gds > /tmp/gds.sql

Restore

pg_restore -U sysop -W -c --if-exists -d gds /tmp/gds.sql