Installation

1) Docker-compose

The server can be started with docker-compose. Therefore, docker and docker-compose have to be installed on the host. The server can also be used without docker-compose, if the postgres and redis servers are running already.

For official Docker installation instructions please visit:

https://docs.docker.com/engine/install/ubuntu/

2) Download the repository

git clone --recursive git@github.com:LSARP/ProteomicsQC.git ProteomicsQC
cd ProteomicsQC

3) Create configuration file

./scripts/generate_config.sh  # generates a .env file for configuration

Edit the .env file

# OMICS PIPELINES CONFIG

## HOMPAGE SETTINGS
HOME_TITLE=Your Hompage Title
HOSTNAME=localhost:8080

## STORAGE
DB=./data/db/
DATALAKE=./data/datalake
COMPUTE=./data/compute
MEDIA=./data/media
STATIC=./data/static

## EMAIL SETTINGS
EMAIL_HOST=smtp.gmail.com
EMAIL_USE_TLS=True
EMAIL_USE_SSL=False
EMAIL_PORT=587
EMAIL_HOST_USER=example@example.com
EMAIL_HOST_PASSWORD=a-strong-password
DEFAULT_FROM_EMAIL=noreply@example.com

## CELERY
CONCURRENCY=8  # Change this to control how many CPU's can be used for jobs

## SECURITY KEYS
SECRET_KEY=...

4) Initiate database

make init  # to start the server the first time

5) Create an admin account

make createsuperuser

And follow the instructions to provide an email address and password.

7) Run the server in production

make collectstatic  # The static url has to be setup with a remote proxy.
make serve  # starts the production server on port 8000

You can now navigate to localhost:8080/admin and login to the admin account with the credentials you provided in step 5.

8) Run a development server (Optional)

make devel

The development server will run on localhost:8000.