Skip to content

Commit 229eca9

Browse files
committed
Update README.md
1 parent affcba1 commit 229eca9

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# HTTPS proxy
22

3-
> [!CAUTION]
4-
> Work in progress!
5-
63
A nginx proxy with HTTPS support for Docker Compose development
74
environments.
85

@@ -23,12 +20,43 @@ volumes:
2320
> [!TIP]
2421
>
2522
> Install [mkcert](https://mkcert.dev) on your host machine and
26-
> generate and install a root certificate by running `mkcert -install`
27-
> on your host machine (one time only).
23+
> generate and install a root certificate on your host machine by
24+
> running (one time only).
25+
>
26+
> ```console
27+
> mkcert -install
28+
> ```
29+
30+
### Mac users
31+
32+
> [!TIP]
2833
>
2934
> Mac users should then do (one time only):
3035
>
31-
> `$ mkdir -p ~/.local/share && ln -s "$(mkcert -CAROOT)" ~/.local/share`
36+
> ```console
37+
> mkdir -p ~/.local/share && ln -s "$(mkcert -CAROOT)" ~/.local/share`
38+
> ```
39+
>
40+
> If you haven't installed mkcert yet, you can do so with Homebrew:
41+
>
42+
> ```console
43+
> brew install mkcert nss
44+
> ```
45+
>
46+
> [Dory](https://github.com/FreedomBen/dory) users must adjust their
47+
> config (run `dory config` or edit `~/.dory.yml`):
48+
>
49+
> ```yaml
50+
> nginx_proxy:
51+
> enabled: true
52+
> container_name: dory_dinghy_http_proxy
53+
> https_enabled: true
54+
> # Update the follow line to point at the dev_certificates
55+
> ssl_certs_dir: /Users/<username>/.local/share/dev_certificates
56+
> image: codekitchen/dinghy-http-proxy:latest
57+
> ```
58+
>
59+
> Remeber to restart Dory.
3260

3361
Use can use the following configuration for the generated certificate:
3462

0 commit comments

Comments
 (0)