CloudDM 4.8.0 adds GreptimeDB as a DataSource
Skip to main content

Install with Docker

CloudDM single-node mode (Alone) runs the web console, data access services, and an embedded metadata database in one container. It is suitable for evaluation, small-scale use, and single-node self-hosting.

You can install CloudDM with Docker Run or Docker Compose. Both methods support the same features with either image. Choose the registry that your deployment host can reach.

Prerequisites​

  • Use a host with an x86_64/amd64 or arm64 architecture.
  • Install Docker Engine. For the Compose method, install Docker Compose v2 as well.
  • Make sure port 8222 is available and allowed by your firewall or cloud security group.
  • Check that the host has no container named cgdm-alone.

Start with Docker Run​

Docker Hub image​

docker run -d --name cgdm-alone \
--restart always \
-p 8222:8222 \
-v cgdm_alone_conf:/root/cgdm/alone/conf \
-v cgdm_alone_logs:/root/cgdm/alone/logs \
-v cgdm_alone_data:/root/cgdm/alone/data \
-v cgdm_mysql_data:/var/lib/mysql \
bladepipe/cgdm-alone:latest

China registry image​

docker run -d --name cgdm-alone \
--restart always \
-p 8222:8222 \
-v cgdm_alone_conf:/root/cgdm/alone/conf \
-v cgdm_alone_logs:/root/cgdm/alone/logs \
-v cgdm_alone_data:/root/cgdm/alone/data \
-v cgdm_mysql_data:/var/lib/mysql \
cloudcanal-registry.cn-shanghai.cr.aliyuncs.com/clougence/cgdm-alone:latest

Start with Docker Compose​

Docker Hub image​

services:
dm_alone:
image: bladepipe/cgdm-alone:latest
container_name: cgdm-alone
restart: always
ports:
- "8222:8222"
volumes:
- cgdm_alone_conf:/root/cgdm/alone/conf
- cgdm_alone_logs:/root/cgdm/alone/logs
- cgdm_alone_data:/root/cgdm/alone/data
- cgdm_mysql_data:/var/lib/mysql

volumes:
cgdm_alone_conf:
cgdm_alone_logs:
cgdm_alone_data:
cgdm_mysql_data:

China registry image​

services:
dm_alone:
image: cloudcanal-registry.cn-shanghai.cr.aliyuncs.com/clougence/cgdm-alone:latest
container_name: cgdm-alone
restart: always
ports:
- "8222:8222"
volumes:
- cgdm_alone_conf:/root/cgdm/alone/conf
- cgdm_alone_logs:/root/cgdm/alone/logs
- cgdm_alone_data:/root/cgdm/alone/data
- cgdm_mysql_data:/var/lib/mysql

volumes:
cgdm_alone_conf:
cgdm_alone_logs:
cgdm_alone_data:
cgdm_mysql_data:

Start the container​

docker compose up -d

Environment variables​

Environment variableDefaultDescription
APP_WEB_PORT8222Web service port. If you change it, update the container port mapping to match.
APP_WEB_JWTValue built into the imageJWT signing key for web sign-in.
APP_SERVE_NAME127.0.0.1Address of the internal CloudDM service.
APP_SERVE_PORT8008Port of the internal CloudDM service.
MYSQL_EMBEDDEDtrueEnables embedded MySQL. Set to false when using an external MySQL database.
MYSQL_ROOT_PASSWORD123456Root password for embedded MySQL.
MYSQL_DATADIR/var/lib/mysqlData directory for embedded MySQL.
MYSQL_SOCKET/run/mysqld/mysqld.sockSocket file path for embedded MySQL.
MYSQL_PID_FILE/run/mysqld/mysqld.pidPID file path for embedded MySQL.
MYSQL_INIT_MARKER$MYSQL_DATADIR/.clouddm_mysql_initializedInitialization marker file path for embedded MySQL.
DB_HOST127.0.0.1Metadata database host.
DB_PORT3306Metadata database port.
DB_DATABASEcdmgrMetadata database name.
DB_USERNAMErootMetadata database username.
DB_PASSWORDSame as MYSQL_ROOT_PASSWORDMetadata database password.
WAIT_DB_TIMEOUT_SECONDS120Seconds to wait for the metadata database to become ready.
WAIT_MYSQL_STOP_SECONDS30Seconds to wait for embedded MySQL to stop.
info

All environment variables are optional. With Docker Run, set a variable at startup with -e NAME=value. With Docker Compose, set variables under environment.