Skip to main content
Version: 1.x

Deployment

Docker Containers​

OpenCDMP is containerized using Docker, with each service running on its own Docker container. This isolation ensures consistency across environments and simplifies deployment.

Simple Deployment​

Deployment configuration is provided to simplify the deployment process.

Prerequisites​

  1. Docker and Docker Compose:

  2. Docker Deployment Knowledge

Deployment Steps​

  1. Clone the demo deployment Repository:

    git clone https://github.com/OpenCDMP/docker-deployment.git
    cd docker-deployment

  2. Start the Services:

    # make sure the deploy script is executable
    chmod 700 deploy_opencdmp.sh

    # Run the deploy script
    ./deploy_opencdmp.sh
    • If you get the error "-bash: ./deploy_opencdmp.sh: cannot execute: required file not found", it means the script has Windows (CRLF) line endings and you need to convert it to Unix (LF). You can either do this by hand in a text editor of your choice or run the following command.
    sed -i 's/\r$//' deploy_opencdmp.sh

  3. Verify the Deployment:

    docker compose ps

  4. Access the Application:

    • Navigate to http://host.docker.internal:8081/.
    • Replace host.docker.internal with your domain or IP if configured differently.
    • Log in with OpenCDMP's admin user.
    User: opencdmp-admin
    Pass: admin

  5. Access and Configure Keycloak (Authentication Service):

    • Navigate to http://host.docker.internal:8081/auth/.
    • Log in with Keycloak's admin user.
       User: keycloak-admin
       Pass: admin
    • Configure realms, clients, users, and roles as needed. (For security reasons, change the password for the keycloak-admin user or recreate it with your own credentials)

Advanced Deployment​

OpenCDMP offers various configuration options per installation. The files at the deployment can be used as a starting point, and edited accordingly. All env files are explained here.

The deployment process should be the same as long as the modified configuration is correct.