hippofish/docs/install-container.md

Running a Firefish server with containers

Prerequisites

• Latest Docker installation
  • You can also use Podman and Podman Compose.

Configuration

Copy the example config files:

cp docker-compose.example.yml docker-compose.yml
cp .config/example.yml .config/default.yml
cp .config/docker_example.env .config/docker.env

then edit them according to your environment. You can configure docker.env with anything you like, but you will have to pay attention to the default.yml file:

• url should be set to the URL you will be hosting the web interface for the server at.
• host, db, user, pass will have to be configured in the PostgreSQL configuration section - host is the name of the postgres container (eg: firefish_db_1), and the others should match your docker.env.
• hostwill need to be configured in the Redis configuration section - it is the name of the redis container (eg: firefish_redis_1)

Everything else can be left as-is.

Pull the container image

The image tag is registry.firefish.dev/firefish/firefish:latest.

docker pull registry.firefish.dev/firefish/firefish:latest
# or podman pull registry.firefish.dev/firefish/firefish:latest

Run

docker compose up --detach
# or podman-compose up --detach

NOTE: This will take some time to come fully online, even after download and extracting the container images, and it may emit some error messages before completing successfully. Specifically, the db container needs to initialize and so isn't available to the web container right away. Only once the db container comes online does the web container start building and initializing the firefish tables.

Once the server is up you can use a web browser to access the web interface at http://serverip:3000 (where serverip is the IP of the server you are running the firefish server on).

To publish your server, please follow the instructions in section 5 of this installation guide.