Installation¶

Requirements and info¶

Python: CPython 3.6+

Operating system: Linux

Prerequisites: docker-compose (recommended) or virtualenv, npm.

Git repository: https://gitlab.com/space-education-development/soniks/soniks-network.git

Clone¶

Consult the GitLab page on how to clone the repository.

Configuration¶

Set your environmental variables:

$ cp env-dist .env
$ ${EDITOR} .env

Installation¶

Quick install¶

The recommended quick install method is to use Docker Compose. This method will start separate containers for Django runserver, Celery, MariaDB and Redis.

The Virtualenv quick install method lacks a task queue, uses SQLite as a database and memcached for caching. It is only recommended for frontend development.

Docker Compose (recommended)¶

Change into the cloned repository directory:

$ cd <path/to/clone>

To run SONIKS Network service:

$ ./soniks.sh up

To stop SONIKS Network service:

$ ./soniks.sh compose down

To clean-up SONIKS Network installation:

$ ./soniks.sh clean

Virtualenv¶

This installation method is recommended only for frontend development purposeses.

Change into cloned repository directory:

$ cd <path/to/clone>

To run SONIKS Network in a virtualenv:

$ ./soniks.sh develop

To remove SONIKS Network virtualenv:

$ ./soniks.sh remove

Production install¶

For production installations, check Deploying Django.

Gunicorn¶

If gunicorn is used as the WSGI server then to start the application use:

$ ./bin/djangoctl.sh run

and to bring Celery up:

$ ./bin/djangoctl.sh run_celery