This repository has been archived on 2025-01-27. You can view files and clone it, but cannot push or open issues or pull requests.
puyoskey-firefish/dev/docs/container.md
naskya d096da02e6 🎉 First Commit
release: v20240729

Co-authored-by: Laura Hausmann <laura@hausmann.dev>
Co-authored-by: GitLab CI <project_7_bot_1bfaee5701aed20091a86249a967a6c1@noreply.firefish.dev>
Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Saamkhaih Kyakya <70475761+hiohlan@users.noreply.github.com>

See merge request firefish/firefish!11214
2024-08-01 00:03:39 +09:00

1.6 KiB

Set up a fully-containerized development environment

Prerequisites

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.