HoovesSocial/hippofish
2
0
Fork 0
Code Issues 3 Pull requests 1 Projects Releases Packages Wiki Activity Actions
hippofish/dev/docker
History
老周部落 0b0edaa958
doc: new env init docs for dev and prod, clear docs, update dependencies
2024-03-05 18:05:30 +08:00
..
docker-compose.yml change dir structure, add docs, download by git 2024-03-04 17:09:59 +08:00
docker-entrypoint.sh change dir structure, add docs, download by git 2024-03-04 17:09:59 +08:00
README.md doc: new env init docs for dev and prod, clear docs, update dependencies 2024-03-05 18:05:30 +08:00

README.md

Containerized Environment

The Firefish repo comes with a new containerized environment to help make development!

Prerequisites

  • Latest Docker installation
  • The following ports are not in use
    • 3030
    • 25432
    • 26379

Start up the environment

  1. Download the dev/docker directory and execute chmod +x docker-entrypoint.sh.
    • Alternatively, you can manually run git clone https://firefish.dev/firefish/firefish.git && cd firefish to fetch needed files, or let the script take care of itself.
  2. Open docker-compose.yml and set URL to the URL you want to use (or leave it to http://localhost:3030).
  3. Run docker compose up. This will build the environment, dependencies and prepare the needed config files.
    • If you use Podman, you should run podman-compose up instead.
  4. 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
  5. 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.