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`

Container images are available from GHCR.io fivenet-app/fivenet registry.

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

If you already have a Docker NGINX Reverse Proxy or similar for exposing your container applications to the world, you can remove/comment out the nginx-proxy container in it. For the Docker NGINX Reverse Proxy, you need to make sure to update the environment variables of each container to match the domain/subdomain name that you use.

To build the FiveNet container image yourself, you need to fulfill the development requirements setup.

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

Make sure to start using the example config file (click here) and modify it as you need.

Checkout the configuration reference page "Must Set Config Options" section and reference list to create a working config.yaml for FiveNet.

3. Run FiveNet

Run the server, worker and discord containers via the docker-compose.yaml :

docker-compose up -d

3.1. Recommendations

If you aren't using a reverse proxy to expose FiveNet, I would recommend using, e.g., nginx-proxy/nginx-proxy, to easily and safely expose the FiveNet server (/) and the Iconify API container (/api/icons).

4. Post Installation Steps

Make sure to follow the post installation steps now.

Hosted

In the current model of the hosted variant, we will take care of running FiveNet for you.

Kubernetes: Using Helm

For installation to Kubernetes a Helm chart is available in our charts repository. The source code of the chart(s) is available on GitHub fivenet-app/charts.