Setup Environment
How to set up your environment to use the server.
Please set some basic details of the server in the .env file. You can find the .env.example file in the root directory of the project.
Warning
Securing file-system access of the host is important. Please make sure that your custom certificate files,.env, .env.idp files etc. are not accessible to unauthorized users.You should also ensure unauthorized persons do not have access to the docker containers. Ensuring the host server is secured, is your responsibility.
Configuration
cp .env.example .env && nano .env
## HELP
# https://get.apis.de/docs/server/env/
## ABOUT
# This will be used to create the root business unit
# Do not use special characters
COMPANY_NAME=
## CDM HOST and PORT
# The hostname to access the server.
# Must not contain protocol such as https://
# Must not have port number
# Must not have trailing slash
# Example: cdm.example.com
CDM_HOST=localhost
# Just the port number; 443 recommended
# Default port is 443
CDM_PORT=443
## USE CUSTOM HTTPS CERTIFICATE FOR CDM-SERVER (PRIVATE-KEY)
# If you have a custom certificate (certificate chain and private-key), set this to true.
# You need to place the custom certificate in the same directory as your `docker-compose.yml` file (where you have downloaded CDM-Server).
# The certificate file name must be `cdm-server.crt` and it has to contain the full certificate chain in PEM format.
# The private key file name must be `cdm-server.key` and it has to contain the private key in PEM format.
# For a false value, a self-signed certificate will be created and used for HTTPS.
# Please check [help docs for more information](https://get.apis.de/docs/server/https/).
# Default is false
USE_CUSTOM_CERT=false
## Session inactivity timeout in seconds. Default value is 3600 ~ 1h
# If the CDM-Server does not receive requests for a session for this amount of time, a background process will terminate the session
# Value needs to be at least 1800 ~ 30min and at most 14400 ~ 4h
SESSION_INACTIVITY_TIMEOUT_IN_SECONDS = 3600
Example
COMPANY_NAME=APIS Informationtechnologien GmbH
CDM_HOST=cdm.apis.de
CDM_PORT=443
USE_CUSTOM_CERT=true
CUSTOM_CERT_PASS=supersecretpassword
COMPANY_NAME
This is the name of your company. It will be used to create the root business unit.
USE_CUSTOM_CERT
See HTTPS for more information.
Setup Up ID Provider (IdP)
After you are done setting up .env, please head over to the IdP Docs to setup .env.idp file.
Permissions for the DotEnv Files
It is recommended that you do not allow other users in same server system to read the DotEnv files as some of them can contain credentials.
You can try chmod 600 on all of them.