hippofish/dev/docs/container.md

Set up a fully-containerized development environment

Prerequisites

• Container runtime installation
  • Docker
  • Podman and Podman Compose
  • containerd and nerdctl
  • or whatever you want to use
• The following ports are not in use
  • 3030
  • 25432
  • 26379

Start up the environment

1. Download the dev/container directory and execute chmod +x docker-entrypoint.sh
   • Alternatively, you can use git clone https://firefish.dev/firefish/firefish.git && cd firefish/dev/container, although this will clone the entire repository.
2. Copy the example config file

   cp config.example.env config.env
   

3. Edit docker-compose.yml and set URL to the URL you want to use (or leave it as http://localhost:3030)
4. Run docker compose up
   • This will build the environment, install dependencies and prepare the needed config files.
   • If you use Podman, you should run podman-compose up instead.
5. Wait until the following message shows up

   DONE *  [core boot]     All workers started
   DONE *  [core boot]     Now listening on port 3030 on https://your_firefish_url.example.com
   

6. A fresh Firefish environment is created on the URL you have set!

When you want to restart the dev server, you just need to terminate the process (a.k.a. press Ctrl+C) and run docker compose up again.