Docker and Docker Compose
Familiarity with Docker and Docker Compose is required.
We simply cannot support custom scenarios or setups. Therefore, it is essential to check your device's memory limits, architecture, and CPU power.
Running FDM Monster with Docker Compose
In the next steps, we will guide you through the process of running FDM Monster with Docker Compose.
Step 1: FDM Monster image and version tag
We provide the fdmmonster/fdm-monster
image. This image requires you to run a MongoDB server, MongoDB Atlas (cloud offering), or a MongoDB docker container (see compose file below).
Find it on Docker Hub.
There are multiple tags available for the fdmmonster/fdm-monster
image.
latest
- The latest version of FDM Monster. This is the default tag.x
,x.y
,x.y.z
- A specific version of FDM Monster. For example,1
,1.4
, or1.4.0
.main
- The latest development version of FDM Monster. This version is the same as thelatest
tag and it is stable.develop
- The latest development version of FDM Monster. This version is not recommended for production use.x.y.z-rc?-1234
- A specific release candidate of FDM Monster with a specific build number. For example,1.4.0-rc1-1234
. These are development versions and are not recommended for production use.x.y.z-1234
- A specific version of FDM Monster with a specific build number. For example,1.4.0-1234
. These are development versions and are not recommended for production use.
Step 2: Create a docker-compose.yml file
To run a Docker Compose stack, create a file named docker-compose.yml
and use the file contents presented below. Note that an option has been added for adding MongoDB authentication.
If you choose not to use authentication, you can remove the MONGO_INITDB_ROOT_USERNAME
and MONGO_INITDB_ROOT_PASSWORD
environment variables.
In that case, you should leave out the <username>:<password>@
part of the MONGO
environment variable.
It's important to protect your MongoDB database with authentication. If you choose not to use authentication, you should at least use a firewall to protect your database. Do not simply expose your database over the internet without any protection! You have been warned.
There is also a development (NODE_ENV=development
) compose file here: docker-compose.yml):
version: '3.4'
services:
mongodb:
image: mongo:latest
container_name: mongodb
environment:
# MongoDB with authentication (optional)
- MONGO_INITDB_ROOT_USERNAME=YOUR_ROOT_NAME
- MONGO_INITDB_ROOT_PASSWORD=YOUR_ROOT_PASSWORD
ports:
- "28017:27017"
volumes:
- ./mongodb-data:/data/db
- ./mongoconfig:/data/configdb
restart: unless-stopped
fdm-monster:
container_name: fdm-monster
image: fdmmonster/fdm-monster:latest
restart: unless-stopped
ports:
- "4000:4000"
environment:
# MongoDB with and without authentication (optional)
- MONGO=mongodb://YOUR_ROOT_NAME:YOUR_ROOT_PASSWORD@mongodb:27017/fdm-monster?authSource=admin
# - MONGO=mongodb://mongodb:27017/fdm-monster?authSource=admin
volumes:
- ./fdm-monster/media:/app/media
# The unstable alpha release version
fdm-monster-alpha:
container_name: fdm-monster-alpha
image: fdmmonster/fdm-monster:1.6.0-rc1-alpha
restart: unless-stopped
ports:
- "4001:4001"
environment:
- NODE_ENV=development
- SERVER_PORT=4001
volumes:
- ./fdm-monster-alpha/media/:/app/media
- ./fdm-monster-alpha/database/:/app/database
An example of a docker-compose.yml file with the MongoDB and FDM-Monster services in one stack.
Step 3: Execute the docker-compose stack
Execute this command to run the containers:
docker-compose up -d
Please note that FDM Monster requires a MongoDB database to function properly. When using the latest
or alpine
images,
make sure to configure your root user's username and password for MongoDB.
Additionally, FDM Monster needs to access the admin
table, which is the default table name for the authentication source.
Now you can access FDM Monster at http://localhost:4000
, http://127.0.0.1:4000
, or http://<your-ip>:4000
.