Skip to content

Latest commit

聽

History

History
50 lines (32 loc) 路 2.74 KB

deploy-with-docker.md

File metadata and controls

50 lines (32 loc) 路 2.74 KB
Raw

Deploy with Docker

Docker compose is the easiest way to deploy a self-hosted instance of Fonoster. This guide will walk you through deploying the Fonoster services using Docker and Docker Compose.

Prerequisites

The only prerequisite for Fonoster is to have Docker installed on the host machine.

Installation

First, create a new directory in your preferred location and change to it. The root directory we will use in the guide is fonoster.

mkdir -p fonoster/etc
cd fonoster

Next, copy the .env.example from the repository to the current directory and rename it to .env. This file contains all the environment variables that the services need to run. You can use the following command to copy the file:

curl -o .env https://raw.githubusercontent.com/fonoster/fonos/main/.env.example
curl -o ./etc/fluent.conf https://raw.githubusercontent.com/fonoster/fonos/main/etc/fluent.conf
curl -o ./etc/vault.json https://raw.githubusercontent.com/fonoster/fonos/main/etc/vault.json
curl -o ./etc/rbac.json https://raw.githubusercontent.com/fonoster/fonos/main/mods/apiserver/etc/rbac.json

Then, open the .env file with your favorite editor and update the following variables:

  • DOCKER_HOST_ADDRESS: The public IP address of your Docker host. If running locally, you can use your local IP address. If you are running the application on a server, you must use the public IP address of your server
  • NEXTAUTH_URL and WEBUI_APP_URL must be the URL where the application will be accessible. For example, if you run the application locally, you can use http://localhost:8080. If you are running the application on a server in the cloud, you can use, for example, https://fonoster.example.com
  • WEBUI_TEST_PHONE_SERVER - The public IP address of your Docker host. If running locally, you can use your local IP address. If you are running the application on a server, you must use the public IP address of your server.

In addition to the previous variables, you should update all the secrets and ensure the .env file is safely stored.

Next, run the following command to start the application:

curl -o ./compose.yaml https://raw.githubusercontent.com/fonoster/fonoster/main/compose.yaml
docker compose up -d

Finally, you can access the application by visiting the URL you set in the WEBUI_APP_URL variable. For example, if you put the variable to http://localhost:8080, you can access the application by visiting http://localhost:8080 in your browser.

Next Steps

Known Issues

  • Running Fonoster in development mode on macOS M2 chips causes several containers to crash and fail. No workaround is available at the moment.