OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub
Ruby agile-developmentangularbcfboardsbug-trackerganttgantt-chartifcissue-trackerjira-alternativekanbanopenprojectproduct-managementproject-managementproject-planningroadmaprubyscrumtimelineworkflows
Update Docker TLS setup instructions and troubleshooting (#19872)
Yauheni Suhakoue55134dda115
diff --git a/docs/development/development-environment/docker/README.md b/docs/development/development-environment/docker/README.mdindex 926d79eee01..3dbd447c83f 100644--- a/docs/development/development-environment/docker/README.md+++ b/docs/development/development-environment/docker/README.md@@ -242,7 +242,7 @@ As an overview, you need to take the following, additional steps:1. Set up a local certificate authority and reverse proxy2. Extract created root certificate and install it into system and browsers-3. Amend docker containers with labels for proxy+3. Amend docker containers with labels for reverse proxyAt the end you will be running two separate docker-compose stacks:@@ -378,12 +378,38 @@ docker compose --project-directory docker/dev/tls up -dIt will take a couple of seconds to start, as there is a health check in the step container.-### Amend docker services+### Amend Docker services for local TLS-The docker services of the `docker-compose.yml` need additional information to be able to run in the local setup with-TLS support. Basically, you need to tell `traefik` for which docker compose service it needs to create a HTTP router.-There is an example compose file (see `docker/dev/tls/docker-compose.core-override.example.yml`), which contents you can-take over to your custom `docker-compose.override.yml` in the repository root.+When running the local setup with TLS, some services in `docker-compose.yml` require additional+configuration so that `traefik` knows which requests to route.++You need to specify, for each service, the `traefik` labels that define its HTTP router.+An example configuration is provided in `docker/dev/tls/docker-compose.core-override.example.yml`.+Copy its contents into your own `docker-compose.override.yml` in the repository root, and adjust hostnames if necessary.++Ensure that both the `backend` and `frontend` services:+- are attached to the same `networks` as `traefik`+- have the appropriate `traefik` labels++Example:++```yaml+frontend:+ networks:+ - external+ labels:+ - "traefik.enable=true"+ ...++backend:+ networks:+ - external+ labels:+ - "traefik.enable=true"+ ...+```+This ensures that traefik will route HTTPS requests for `openproject.local` and `openproject-assets.local` to the+correct containers in your local setup.In addition, we need to alter the environmental variables used in the new overrides. So we need to amend the `.env` filelike that:@@ -396,7 +422,7 @@ OPENPROJECT_DEV_URL=https://${OPENPROJECT_DEV_HOST}After amending the override file and the `.env`, ensure that you restart the stack.```shell-docker compose up -d frontend+docker compose up -d backend```### Adding a new service@@ -425,6 +451,26 @@ docker compose --project-directory docker/dev/tls downdocker compose --project-directory docker/dev/tls up -d```+#### Blank page on `openproject.local`++A blank page on `openproject.local` can indicate that compilation is either in progress or has failed. To investigate, check the frontend container output:+```shell+docker compose logs frontend`+```+Sometimes compilation errors can occur due to broken node_modules state(for example after switching branches or partial installations). It can be resolved by removing node_modules and installing from scratch:+```shell+rm -rf frontend/node_modules/+docker compose run --rm frontend npm install+```++Then restart both the frontend service:+```shell+docker compose restart frontend+```++If the issue persists, clear your browser cache and reload the page.+Cached assets from a previous build may prevent the updated frontend from loading correctly.+## GitLab CE ServiceWithin `docker/dev/gitlab` a compose file is provided for running local Gitlab instance with TLS support. This provides