README.md

mySAGW

!!!WIP!!!

Application management for SAGW

Getting started

Installation (dev)

Requirements

• docker
• docker-compose

After installing and configuring those, download docker-compose.yml and run the following command:

echo "UID=$(id -u)" > .env
docker-compose up -d

Load the config data into Caluma:

make caluma-loadconfig

Add mysagw.local to /etc/hosts:

echo "127.0.0.1 mysagw.local" | sudo tee -a /etc/hosts

You can now access the application under the following URIs:

• https://mysagw.local/ --> frontend
• https://mysagw.local/auth/ --> keycloak
• https://mysagw.local/api/ --> backend
• https://mysagw.local/graphql/ --> caluma

Configuration

mySAGW is a 12factor app which means that configuration is stored in environment variables. Different environment variable types are explained at django-environ.

Deployment

cp -r ./.envs/.production.example ./.envs/.production

Then edit the files under ./.envs/.production/ to your needs.

For the staging envireonment, copy to ./.envs/.staging/.

echo -e "UID=$(id -u)\nCOMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml" > .env
# on staging environments:
# echo -e "UID=$(id -u)\nCOMPOSE_FILE=docker-compose.yml:docker-compose.staging.yml" > .env
docker-compose up -d
make caluma-loadconfig

Contributing

Look at our contributing guidelines to start with your first contribution.