Skip to content

Get Started

Jump to bottom
Andreas edited this page Dec 9, 2024 · 47 revisions

Installation of Open Datenschutzcenter

This guide describes the steps to install the Open Datenschutzcenter using Docker and Docker-Compose. The easiest way to install the ODC is by using the pre-configured Dockerimages and the provided config files. The Composer will setup the Application together with a Treafik Load Balancer, MySQL Database, and Keycloak. Please perform the following steps as the root user.

su root
cd /tmp

Step 1: Install Docker and Docker-Compose

First, you need to configure an APT repository and install Docker and Docker-Compose in the latest version.

wget https://git.h2-invent.com/Meetling/Docker-Compose/raw/branch/main/installDocker.sh 
bash installDocker.sh
rm installDocker.sh

Step 2: Set up the configuration for Docker-Compose

Next, set up the configurations for Docker-Compose and deploy the container.

wget https://git.h2-invent.com/Datenschutzcenter/Docker-Compose/raw/branch/main/setup.sh
bash setup.sh
rm setup.sh

Step 3: Change to the configuration directory and start the container

Now, change to the configuration directory and start the Docker container.

cd /opt/odc
docker-compose up -d

Step 4: Set up DNS or local hosts file

To access the Open Datenschutzcenter, you need to adjust your DNS settings or the local hosts file to point the domain to your server. You can use your DNS server to add the URL for the Open Datenschutzcenter or add your DNS entry in the local file on your computer or server.

# /etc/hosts
127.0.0.1       dev.domain.de

Step 5: Register your User account

After completing these steps, you should be able to access the application (e.g. http://dev.domain.de) with any Browser. On the login screen of the application, you can click "Register" to create your first user. After the Registration, you get redirected to the ODC application to create your first Company.

Conclusion

After completing these steps, you should be able to access and use the Open Datenschutzcenter by access the selected domain in the Browser. If you have any questions or issues, please consult the official documentation or contact support. The Repo for the Docker-Compose Configuration can be found here: Docker-Compose Repo

Optional: External Load Balancer

To use an external Load Balancer, you can use the following Docker-Compose file which configures the Containers to use Host Ports, so you can use the published ports in the Upstream Config of e.g. NGINX or HaProxy

Optional: Configuration directory

The setup script will clone and add files into the directory /opt/odc.

You can run the composer command inside this directory again to update the containers or check the variables which are used to setup the containers.

cd /opt/odc

Following Files are important and have been changed and setup with the script:

  • .env.local
  • docker.config
  • docker-compose.yml

Optional: Custom Configuration

To add additional custom environment variables, you can add a file .env.custom and add your variables there. This file will not be changed from the setup script and will be used inside all containers to overwrite the existing .env and .env.local. All environment variables can be found inside the Git Repository: Open Datenschutzcenter

# cat .env.custom

MAILER_DSN='smtps://<username>:<password>@<smtpHost>:<smtpPort>'
[email protected]
registerEmailName=Datenschutzcenter
[email protected]
defaultEmailName=test
[email protected]
[email protected]
[email protected]
[email protected]

imprint=https://h2-invent.com/imprint
dataPrivacy=https://h2-invent.com/gdpr
superAdminRole=odc-super-admin

CRON_TOKEN=token
Clone this wiki locally