Install and run using docker

It is assumed that you are familiar with basic docker commands. Docker should be properly installed and running in your system.

• Make sure you have understood how tgcf is run by passing certain variables via command-line options or by setting them as environment variables.
• Read about tgcf.config.yml to know how you can configure tgcf

Install

Pull the official docker image from DockerHub.

docker pull aahnik/tgcf

Tip: Use aahnik/tgcf:minimal for a smaller image size. (beta)

Configure

• Write all your environment variables in a file called .env.
• Write your configuration in tgcf.config.yml.

Run

docker run -v absolute/path/to/tgcf.config.yml:/app/tgcf.config.yml -d --env-file .env aahnik/tgcf

Note:

• the -d flag tells the docker command to run the container in detached mode.
• the --env-file option passes the file .env for its variables to be used inside the container.

Check

To see if your container is running,

$ docker ps
CONTAINER ID   IMAGE               COMMAND       CREATED          STATUS          PORTS     NAMES
ae4d7d6651ca   aahnik/tgcf      "tgcf --loud"   3 minutes ago    Up 3 minutes              zen_gates

The container id and name will be different in your machine.

To see the logs produced by the container,

$ docker logs zen_gates

Replace zen_gates with the name of the container in your machine.