* example readme

.gitignore

+rights-engine/.env
+rights-engine/id_rsa
+rights-engine/id_rsa.pub
+rights-engine/db/*
+mongodb/mongodb_data/*
+mongodb/.env
+analytics-engine/.env

README.md

@@ -18,3 +18,74 @@ F(Deployment:Rights-Engine)---id1[(MongoDB)]
 I(Deployment:Dashboard-SDK)---id1[(MongoDB)]
 end
 ```
+# Getting started 
+Each folder contains one of the components of 
+
+## Login in the docker registry 
+If you are not already logged in, you need to authenticate to the Container Registry by using your GitLab username and password. If you have Two-Factor Authentication enabled, use a Personal Access Token instead of a password.
+```bash
+docker login registry.digitallearning.gmbh
+```
+
+## LRS / MongoDB
+First we need a database or LRS to store the xAPI Statements. In a local setup, you can use the docker container in the mongodb folder. 
+Rename or copy the sample configuration. Please change all passwords in the configuration file. 
+
+```bash
+cd mongodb
+cp .env.sample .env
+```
+Now you can start the mongodb with the following command
+```bash
+docker compose up -d
+```
+
+Please check that the database is created:
+```bash
+docker compose ps
+```
+
+
+## Rights engine
+First create some jwt keys with the following command:
+
+```bash
+cd rights-engine
+ssh-keygen -t rsa -b 4096 -m PEM -f id_rsa
+openssl rsa -in id_rsa -pubout -outform PEM -out id_rsa.pub
+```
+
+Leave the passphrase empty. 
+Rename or copy the sample configuration. Please change all passwords in the configuration file. 
+```bash
+cp .env.sample .env
+```
+
+Now you can start the rights engine with the following command
+```bash
+docker compose up -d
+```
+
+Please check that all services are started:
+```bash
+docker compose ps
+```
+
+After that you should be able to visit http://localhost:80/ and see the rights engine.
+
+## Analytics engine
+Rename or copy the sample configuration. Please change all passwords in the configuration file. 
+```bash
+cd analytics-engine
+cp .env.sample .env
+```
+
+Now you can start the analytics engine with the following command
+```bash
+docker compose up -d
+```
+
+## Update Docker Images 
+```bash
+docker compose pull
+```
\ No newline at end of file

analytics-engine/.env.sample

+DYNACONF_SQLALCHEMY_DATABASE_URI=postgresql://postgres:CHANGE_ME@database/analytics-engine
+DYNACONF_CELERY_BROKER_URL=redis://:CHANGE_ME@redis_db:6379/0
+DYNACONF_CELERY_RESULT_BACKEND=redis://:CHANGE_ME@redis_db:6379/1
+DYNACONF_ANALYTICS_BACKEND_URL=http://scheduler:5000
+DYNACONF_RIGHTS_ENGINE_BACKEND_URL=http://localhost:80/
+WEBSITE=analytics
+URL=$DEPLOYMENT_URL
+REDIS_PASSWORD=CHANGE_ME
+POSTGRES_USER=postgres
+POSTGRES_DATABASE=analytics-engine
+POSTGRES_PASSWORD=CHANGE_ME
\ No newline at end of file

mongodb/.env.sample

+MONGO_USER=root
+MONGO_PASSWORT=CHANGE_ME
\ No newline at end of file

.env.sample → rights-engine/.env.sample

 URL=localhost
-MYSQL_ROOT_PASSWORD=CHANGEME
 WEBSITE=polaris
-DB_PASSWORD=CHANGEME
+DB_PASSWORD=CHANGE_ME
 DJANGO_DEVELOPMENT=false
 DATABASE_NAME=polaris
 DATABASE_USER=root
-DATABASE_PASSWORD=CHANGEME
+DATABASE_PASSWORD=CHANGE_ME
 DATABASE_HOST=database
 DEBUG=False
 LRS_HOST=http://learninglocker.digitallearning.gmbh:8080
-LRS_TOKEN=CHANGEME
-LRS_CONNECTION_STRING=mongodb://root:CHANGEME@database:27017
+LRS_TOKEN=CHANGE_ME
+LRS_CONNECTION_STRING=mongodb://root:CHANGE_ME@127.0.0.1:27017
 LRS_MONGO_DB_NAME=lrs
 DATA_DISCLOSURE_EXPIRATION=30
 DATA_DISCLOSURE_LOCATION=/usr/src/app/backend/data_disclosure_zips
@@ -18,10 +17,9 @@ EMAIL_HOST=
 EMAIL_PORT=
 EMAIL_HOST_USER=
 EMAIL_HOST_PASSWORD=
-REDIS_PASSWORD=CHANGEME
-CELERY_BROKER_URL=redis://:CHANGEME@redis:6379/0
+REDIS_PASSWORD=CHANGE_ME
+CELERY_BROKER_URL=redis://:CHANGE_ME@redis:6379/0
 JWT_PUBLIC_KEY_PATH=backend/id_rsa.pub
 JWT_PRIVATE_KEY_PATH=backend/id_rsa
 IDP_SERVER=https://aai-test-v3.ruhr-uni-bochum.de
-IDP_ENABLED=false
-THIRD_PARTY_ACCESS_TOKEN=
+IDP_ENABLED=false
\ No newline at end of file