Installation & Configuration

Before starting the deployment of our digital lab book, please make sure to read atleast this guide once to get an overview of the deployment process.

git clone https://gitlab.gwdg.de/irp-snip/snip.git
# or
# git clone git@gitlab.gwdg.de:irp/snip.git
cd snip

Prerequisites

Deployment of our digital lab book can be done via docker containers. The system(s) dedicated to running the platform should have Docker and Docker Compose installed. You can find the installation instructions for Docker and Docker Compose on the official Docker website.

• Docker
• Docker Compose

To use all functionalities of the platform, you should also have a SMTP server available. This is used to send out E-Mails for account verification and password reset.

Configuration

We use a global .env file in the root directory of the project. You may copy the .env.example file to .env and adjust the settings to your needs. You need to do this before starting the application the first time!

cp .env.example .env
cat .env

You can find the configuration of all environment variables in the .env.example file.

Start the application

To start the stack with all services, you can use the following command:

docker compose up

SSL Configuration

By default we supply a self signed certificate for development purposes. For production use, you should replace the certificate.crt and certificate.key files in the ./apps/nginx/ssl directory with your own certificate and key files. Alternatively, you may also change the mounted ssl directory in the docker-compose.yml file.