Installation
Linux Knowledge Required
Installation requires an admin familiar with Linux. You will need to enter the commands in a terminal. The instructions here assumes you have common utilities likecurl
, tar
, nano
installed.Step 1: Install Docker Compose
Make sure Docker Engine (with docker-compose-plugin
) is installed on your system.
See System Requirements for more details.
You may also try alternatives such as Podman.
Step 2: Download the Docker-Compose File
Go to the directory you want to download CDM-Server in, and run:
curl -s https://get.apis.de/cdm.sh | bash
curl -s https://get.apis.de/cdm.sh | bash -s v1.0.0
If you want to do it manually, you can get the docker-compose file from the following link: https://get.apis.de/cdm/latest.tar.gz
#!/bin/bash
# URL of the tar.gz file
url="https://get.apis.de/cdm/latest.tar.gz"
# Download the tar.gz file
curl -O "$url"
# Extract the tar.gz file
tar -xzvf "latest.tar.gz"
# Optional: Remove the tar.gz file after extraction
rm "latest.tar.gz"
chmod +x download
chmod +x start
chmod +x stop
echo "CDM setup has been downloaded and extracted."
Step 3: Create the DotEnv
Files
To use the server, you need to provide some data in the form of two DotEnv
files:
.env
.env.idp
Create new DotEnv
files, copy the contents of the example files, and update the values with your own configuration.
.env
File
Example: .env.example
cp .env.example .env && nano .env
.env.idp
File
Example: IdP (ID Provider) specific DotEnv
files:
.env.idp.azure.example
.env.idp.ldaps.example
.env.idp.local.example
cp .env.idp.local.example .env.idp && nano .env.idp
cp .env.idp.azure.example .env.idp && nano .env.idp
cp .env.idp.ldaps.example .env.idp && nano .env.idp
Detailed DotEnv Guide
More details here: Setting Up DotEnv FilesStep 4: Login and Download CDM-Server Images
Use the following command to login and download the CDM-Server images
. You’ll be asked to enter username and password.
APIS CDM-Server Account
You need to have a valid account to download the images. If you don’t have one yet, please contact customer service through Support Pagesudo ./download
Step 5. Start the CDM-Server Services
sudo ./start
How to Stop
In case, you need to stop CDM-Server services:
sudo ./stop
Step 6. Access CDM-Server
Please see Login for more information.