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

Support automatic Let's Encrypt #108

Closed
wants to merge 21 commits into from
Closed
Changes from 1 commit
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
17 changes: 5 additions & 12 deletions docs/source/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ up **manually** with your own key and certificate.
```python
c.Proxy.traefik_auto_https=True
```
* Configure a HTTPS port. This is where all the traffic coming through the HTTP entrypoint will be redirected to:
```python
c.Proxy.traefik_https_port=443
```
* Set the email address used for Let's Encrypt registration:
```python
c.Proxy.traefik_letsencrypt_email=""
Expand All @@ -27,6 +23,10 @@ up **manually** with your own key and certificate.
```python
c.Proxy.traefik_acme_server="https://acme-v02.api.letsencrypt.org/directory"
```
* Set the port to be used by Traefik for the Acme HTTP challenge:
```python
c.Proxy.traefik_acme_challenge_port="https://acme-v02.api.letsencrypt.org/directory"
GeorgianaElena marked this conversation as resolved.
Show resolved Hide resolved
GeorgianaElena marked this conversation as resolved.
Show resolved Hide resolved
```
<span style="color:green">**Note !**</span>

**TraefikProxy**, supports only the most common challenge type, i.e. the [HTTP-01 ACME challenge](https://letsencrypt.org/docs/challenge-types/#http-01-challenge).
Expand All @@ -41,13 +41,6 @@ up **manually** with your own key and certificate.
c.JupyterHub.ssl_cert = '/path/to/my.cert'
```

Traefik will then redirect all HTTP traffic to the HTTPS entrypoint. The default HTTPS entrypoint port is 8843, but can be configured through:
```python
c.Proxy.traefik_https_port=443
```

## How-To HTTPS for external Traefik-Proxy
If the proxy isn't managed by JupyterHub, HTTPS can be enabled through Traefik's static configuration file.
Checkout Traefik's documentation for:
* [Setting up ACME (Let's Encrypt) Configuration](https://docs.traefik.io/v1.7/configuration/acme/)
* [How to redirect HTTP traffic to HTTPS](https://docs.traefik.io/v1.7/user-guide/examples/#http-redirect-on-https)
Checkout Traefik's documentation for [setting up ACME (Let's Encrypt) configuration](https://docs.traefik.io/v1.7/configuration/acme/)