Using Docker

1. Install Docker Engine and Docker Compose

You need Docker Engine, as the container runtime, and Docker Compose to easily run FiveNet using containers.

Please use one of the many guides available on the internet to install Docker Engine and Docker Compose on your server, e.g., https://docs.docker.com/engine/install/.

Depending on your server's operating system, make sure to start the Docker Daemon using systemctl start docker .

To check that Docker and Docker Compose is ready you can use the following commands:

docker version
docker-compose version

You can now continue to the next step of preparing the docker-compose.yml for your case.

2. Prepare docker-compose.yml

Checkout the docker-compose.yml (click me) as a starting point for you.

You can remove the mysql container as you should use your FiveM server's database anyways.

If you use the NATS server from the default docker-compose.yaml , the nats.url in your FiveNet config.yaml should look like this: url: "nats://fivenet:fivenet_topsecret@localhost:4222" .

2.3. Prepare FiveNet Config

Checkout the configuration page to create a config.yaml for FiveNet.

3. Run FiveNet

Run the server, worker and other components either via the docker-compose.yaml or manually via binary.

4. Add FiveNet Plugin to your FiveM gameserver

Plugin code can be found here.