Skip to content

Server Configuration

How to config

$ CONFIG_VAR=xxx make start

1. Api Engine

all related configuration variable is written in .makerc/api-engine.

API_ENGINE_WEBROOT

default: /engine

description: Web ROOT for api engine, which defined the url where user can visit to api engine.

usage:

$ API_ENGINE_WEBROOT=/engine make start

API_ENGINE_SERVICE_PORT

default: 8085

description: External port of api engine, only work for docker-compose deploy.

usage:

$ API_ENGINE_SERVICE_PORT=8085 make start

API_ENGINE_ADMIN_TOKEN

default: administrator

description: Default operator token of api engine, which have the maximum rights.

usage:

$ API_ENGINE_ADMIN_TOKEN=administrator make start

API_ENGINE_ADMIN_USERNAME

default: admin

description: Default operator username of api engine, who have the maximum rights.

usage:

$ API_ENGINE_ADMIN_USERNAME=admin make start

API_ENGINE_ADMIN_PASSWORD

default: pass

description: Default operator pass of api engine, who have the maximum rights.

usage:

$ API_ENGINE_ADMIN_PASSWORD=pass make start

API_ENGINE_ADMIN_EMAIL

default: admin@cello.com

description: Default operator email of api engine, who have the maximum rights.

usage:

$ API_ENGINE_ADMIN_EMAIL=admin@cello.com make start

API_DOCKER_HOST

default: unix://var/run/docker.sock

description: Docker host for launch agent container, can be unix socket or ip:port, if use remote docker host, remember download all agent images.

usage:

$ API_DOCKER_HOST=unix://var/run/docker.sock make start

API_VERSION

default: master

description: API version shown in swagger.

usage:

$ API_VERSION=master make start

2. Dashboard

DASHBOARD_SERVICE_PORT

default: 8085

description: External port for dashboard, only work for docker-compose.

usage:

$ DASHBOARD_SERVICE_PORT=8085 make start

Below configurations only work for make start-dashboard-dev, and must install all need node modules under the src/dashboard folder.

MOCK

default: True

description: Whether start the dashboard with mock mode, all the data is mock.

usage:

$ Mock=True make start-dashboard-dev

PROXY

default: empty

description: When MOCK=False, this variable will have effect, set the api engine server url, where the api request will redirect to.

usage:

$ PROXY=http://api-engine-server:8085/engine make start-dashboard-dev