From a8627b615a09d02acd62263df6255c849e49c008 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arne=20J=C3=B8rgensen?= Date: Tue, 26 Nov 2024 10:30:34 +0100 Subject: [PATCH] Update README.md --- README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e359c6a..0eadfb2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ # HTTPS proxy -> [!CAUTION] -> Work in progress! - A nginx proxy with HTTPS support for Docker Compose development environments. @@ -23,12 +20,37 @@ volumes: > [!TIP] > > Install [mkcert](https://mkcert.dev) on your host machine and -> generate and install a root certificate by running `mkcert -install` -> on your host machine (one time only). +> generate and install a root certificate on your host machine by +> running (one time only). +> +> ```console +> mkcert -install +> ``` + +### MAc users + +> [!TIP] > > Mac users should then do (one time only): > -> `$ mkdir -p ~/.local/share && ln -s "$(mkcert -CAROOT)" ~/.local/share` +> ```console +> mkdir -p ~/.local/share && ln -s "$(mkcert -CAROOT)" ~/.local/share` +> ``` +> +> [Dory](https://github.com/FreedomBen/dory) users must adjust their +> config (run `dory config` or edit `~/.dory.yml`): +> +> ```yaml +> nginx_proxy: +> enabled: true +> container_name: dory_dinghy_http_proxy +> https_enabled: true +> # Update the follow line to point at the dev_certificates +> ssl_certs_dir: /.local/share/dev_certificates +> image: codekitchen/dinghy-http-proxy:latest +> ``` +> +> Remeber to restart Dory. Use can use the following configuration for the generated certificate: