ManageCat docker image uses an environment file to configure the agent. Environment file must include the following key-value pairs.

#ManageCat Agent Variables

MANAGECAT_ACCOUNT_KEY=Your SaaS Account Key. When you register from ManageCat, you will be given an account key. See below how to find account key from UI.

MANAGECAT_DOCKER_AGENT_HOST=Docker agent hostname or IP address.

MANAGECAT_DOCKER_AGENT_PORT=8090 (Agent port, no need to change. If you use ManageCat SaaS, you have to open this port in your firewall. Otherwise UI can not reach your agent. If you use secure port, then provide HTTPS port. Please see below vairables for HTTP and HTTPS port configuration.)

MANAGECAT_DOCKER_AGENT_SECURE=false (Agent runs in HTTP or HTTPS mode. If you want to have secure agent communication, then you need to change the above parameter to HTTPS port. Please see below vairables for HTTP and HTTPS port configuration.)

MANAGECAT_DOCKER_ENGINE_SWARM_ENABLED=false (ManageCat also supports to manage swarm clusters. If you have swarm cluster then change it to true and provide Swarm manager host in ENGINE HOST)

#Docker Hub/Registry Variables

Provide your Docker hub user details to pull images via UI.

DOCKER_REGISTRY_URL=https://index.docker.io/v1/

DOCKER_REGISTRY_USER=Your docker hub username

DOCKER_REGISTRY_PASSWORD=Your docker hub password

DOCKER_REGISTRY_EMAIL=Your docker hub email

#ManageCat UI Variables

No need to update if you use SaaS Controller. If you use onpremise installation, provide Collector and Controller URL address. such as http://192.168.1.1:8090/controller/ and http://192.168.1.1:8090/collector/.

MANAGECAT_CONTROL_ENABLED=true

MANAGECAT_MANAGEMENT_ENABLED=true

MANAGECAT_COLLECTOR_URL=https://collector.managecat.com/

MANAGECAT_CONTROLLER_URL=https://saas.managecat.com/

#ManageCat Agent HTTP and HTTPS Configuration

No need to update. In default agent configuration, internal server runs HTTP and HTTPS in 8090 and 8443 ports. You can changes these ports with the following environment variables. If you want to enable HTTPS, you must also provide values for KEYSTORE file and KEYSTOREPASSWORD keys.

MANAGECAT_DOCKER_AGENT_HTTPS_KEYSTOREFILE=conf/sample.jks

MANAGECAT_DOCKER_AGENT_HTTPS_KEYSTOREPASSWD=changeit

MANAGECAT_DOCKER_AGENT_HTTPS_PORT=8443

MANAGECAT_DOCKER_AGENT_HTTP_PORT=8090

How to Run Image

Create a file named env.list with the above configuration parameters. You can find your account key from UI. Just login to the controller UI and go to Misc/License Information for onpremise installation, Misc/Subscription Information for SaaS usage, i.e using https://saas.managecat.com.

Run the following command in your command line: (You may have root access to run this command)