Skip to content

local-development.md

Latest commit

 

History

History
36 lines (24 loc) · 1.45 KB

local-development.md

File metadata and controls

36 lines (24 loc) · 1.45 KB
Raw

Docker setup

Prerequisites

  • This repository cloned
  • Docker installed
  • Docker Compose installed

Environment Setup

The project assumes it is running on a domain instead of localhost, which has some drawbacks. To avoid said drawbacks, we use the hosts file to create our local domain to develop on.

I picked local-whysodank.com as the domain but you can pick anything and change the environment variables in .env file.

  • Add the following entries to your hosts file: (for linux this file is commonly located at commonly in /etc/hosts)
  127.0.0.1 local-whysodank.com
  127.0.0.1 api.local-whysodank.com
  127.0.0.1 admin.local-whysodank.com
  127.0.0.1 auth.local-whysodank.com
  127.0.0.1 media.local-whysodank.com
  • Copy example.env to a new file .env in project root and update the domain values if you are not using local-whysodank.com

Run the project

  • docker compose build Running up instead may give you errors about not being able to pull wsd:latest since it is built locally and reused
  • docker compose up After building it first, the wsd:latest will be reused successfull and everything should work out of the box

Caveats

  • Doesn't have volumes mounted for the actual workdir so you have to rebuild the image every time you change something (you can add the volumes manually and do git update-index --assume-unchanged <file> docker-compose.yml)
  • It probably doesn't work in Apple Silicon and maybe not even on Windows.