Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #29

Merged
merged 1 commit into from
Nov 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 34 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# HTTPS proxy

> [!CAUTION]
> Work in progress!

A nginx proxy with HTTPS support for Docker Compose development
environments.

Expand All @@ -23,12 +20,43 @@ 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`
> ```
>
> If you haven't installed mkcert yet, you can do so with Homebrew:
>
> ```console
> brew install mkcert nss
> ```
>
> [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: /Users/<username>/.local/share/dev_certificates
> image: codekitchen/dinghy-http-proxy:latest
arnested marked this conversation as resolved.
Show resolved Hide resolved
> ```
>
> Remeber to restart Dory.

Use can use the following configuration for the generated certificate:

Expand Down