Useful commands for FME Server for Docker

• This article covers some useful commands for FME Server for Docker.

Add more engines to FME Server

By default, we start with one engine, but with Docker compose it is easy to scale. The “2” in the below command can go as high as you like as long as your license supports a number of engines you select.

docker-compose up --scale fmeserverengine=4

Upgrade to a newer version of FME Server

• Create a backup of FME Server
• Stop and remove containers:

docker-compose down -v

• Download the latest docker-compose.yml file
• Pull the latest FME Server for Docker images:

docker-compose pull

• Start FME Server:

docker-compose up -d

• Restore the backup of FME Server

More details on how to backup & restore FME Server can be found here.

FME Server versions for Docker

Names of Services in the Compose file

The different FME Server components are separated into named services. It is useful to know what the names of the services are for the different Docker Compose commands.

• fmeservercore - The core FME Server container
• fmeserverweb - The web front end container
• fmeserverdb - The backend database for FME Server
• fmeserverengine - The FME engines that accept jobs
• fmeserverqueue - The FME Server queue manging the jobs

Useful Docker Compose Commands

The commands below can pass in a parameter <service>. This should be one of the 4 services listed above. In some cases, passing in no service will perform the action on all the services. For example docker-compose stop fmeservercore will stop only the core, and docker-compose stop will stop all services. All these commands should be run in the same directory as the docker-compose.yml file or reference the docker compose file you want to use:

• If your compose file is not named docker-compose.yml you can use the -f option to use your file:

docker-compose -f /Users/YourName/Docker/docker-compose-2018.yaml up -d

• Create and start all services. The -d option starts them in the background which is highly recommended:

docker-compose up -d

• Shutdown, start or restart a service:

docker-compose start <service>
docker-compose stop <service>
docker-compose restart <service>

• Kill a service. This will kill the process in the container instead of sending it the stop command:

docker-compose kill <service>

• View logs of the main process running in the container:

docker-compose logs <service>

• Scale - this command will launch additional containers of the specified service. This will only work with the fmeserverengine service.

docker-compose up --scale fmeserverengine= <num_of_engines>

• Delete the containers. The next time you start them new instances of the containers will be created:

docker-compose rm <service>

• View running containers:

docker-compose ps

• Stop and remove all containers:

docker-compose down