dataplan/ds repository overview

⁠🐳 DS Dockerized - DS Container 💻 📦 Steps for starting a fresh container of the DataplanServer (Latest Release) ❗❗ After the first installation, you just need to follow Step 4.5 and Step 4.6

⁠How to start?

Step 1 and Step 2 need to be done once. If you consider that your local installation is corrupt, you may need to follow these steps again.

⁠Step 1: Clean your Docker environment

1. Clean your local Docker installation by running docker system prune -a -f --volumes. This will delete unused volumes, images, containers, and networks.
2. Make sure that the port 8081 is not being used by another service.

⁠Step 2: Start a Docker Container in DEMO mode

Start a fresh instance of the DataplanServer in a Docker container. (This could take a while)

docker volume create ds_volume && docker run -d \
    --mac-address 02-42-AC-14-00-02 \
    -v ds_volume:/ds \
    -p 8081:8081 \
    --name ds \
    dataplan/ds

This command will:

• Create a volume named ds_volume, where data will be persisted
• Pull the latest image published on the dataplan/ds Docker Hub
• Create a container named ds with the MAC address 02-42-AC-14-00-02. We recommend changing this address to a custom one.
• Expose and bind port 8081
• Attach the created volume ds_volume to the ds container
• Start the ds container in detached mode. This means without console logs on the current terminal

The DataplanServer will start in demo mode and will be available under http://localhost:8081/dp/portal⁠. The initial login is admin/dataplan.

⁠What's next?

⁠Step 3. Get a valid license and a valid config.xml file for production environment

• You have to get a valid license. Logon to the DataplanServer and open the Administration/ManageServer App, choose the Licenses Tab. Please download the ds.lic file and send us this file via email in order to activate it.
• You have to download a copy of the created config.xml file. Choose the Configuration Tab and download the config.xml file.

⁠Step 4. Start with docker-compose

1. Create a folder named ds and a docker-compose.yaml file inside it with the command: mkdir ds && touch ./ds/docker-compose.yaml. Add the following instructions to the compose file.

version: "3.9"
services:
  dataplanserver:
    image: dataplan/ds
    container_name: ds
    # define your custom mac address, Keep im mind that ds.lic file makes use of this address
    mac_address: 02-42-AC-14-00-02  
    ports:
      - 8081:8081
    volumes:
      - root-data:/ds
      - ./ds.lic:/ds/ds.lic
      - ./config.xml:/ds/conf/config.xml

volumes:
  root-data:
    name: ds_volume

networks:
  default:
    name: ds_network

1. Add the activated ds.lic file to the project folder.
2. Add the config.xml file to the project folder.
3. If needed, change the mac_address field in the docker-compose.yaml file. Remember that we issue a valid license bound to a MAC address.
4. Stop any running Docker container of the ds by executing docker rm -f ds.
5. Run docker-compose up -d inside the project folder.

The DataplanServer will start in production mode and will be available at http://localhost:8081/dp/portal⁠.

⁠Update to the latest beta

1. Ensure the ds container is running.
2. Create an executable file and grant permissions with the command: touch ./update_ds_docker && chmod 744 update_ds_docker.
3. Add the following instructions to the file.

#!/bin/sh
docker exec --privileged ds \
    java -cp jsupdateservice.jar dataplan.updateservice.DpUpdateService -downloadandinstall -betaversion -nobackup \
    && docker restart ds

1. Execute the script ./update_ds_docker

Your Docker container should be updated to the latest beta. It will be available at http://localhost:8081/dp/portal⁠.

⁠What about SSL and AWS, Hetzner, or other Cloud providers

⁠SSL via Nginx or Traefik

We recommend exposing the HTTP port of the ds application and managing SSL connections through a reverse proxy like Nginx⁠ or Traefik⁠. This makes it possible to deploy the DataplanServer into a Kubernetes Cluster. Alternatively, you can expose the HTTPS port of the container and configure it as needed. If you want more information about this subject, feel free to open a ticket in our ticket system.

⁠Deployment to the Cloud

We recommend copying the docker-compose.yaml file and other specific files for your installation, such as the config.xml. However, feel free to open a ticket in our ticket system. We will be happy to help you with your Docker deployment to the cloud.

⁠Deprecated: Copy the config file to the remote server

1. Make sure that the destination folder exists on the remote machine
2. Copy the files scp -r some_file some_path user@some_ip:/path/to/. For example: scp docker-compose.yaml 'pi3:$HOME/dataplan.de/ds'
3. Upload the license file to the remote Machine if needed.
4. Start the server docker-compose up -d