Skip to content

Commit 2e926de

Browse files
committed
Add schema docs for subdomain_host
1 parent 80fc378 commit 2e926de

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

jupyterhub/values.schema.yaml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ properties:
217217
values, you need to use [`hub.extraConfig`](schema_hub.extraConfig)
218218
instead.
219219
220-
```{admonition} Currently intended only for auth config
220+
```{admonition} Some configuration must be set in multiple places
221221
:class: warning
222222
This config _currently_ (0.11.0) only influence the software in the
223223
`hub` Pod, but some Helm chart config options such as
@@ -271,6 +271,24 @@ properties:
271271
the `--values` or `-f` flag. During merging, lists are replaced while
272272
dictionaries are updated.
273273
```
274+
properties:
275+
subdomain_host:
276+
type: string
277+
description: |
278+
The subdomain to use for hosting singleuser servers.
279+
280+
This helps protect against some cross-origin attacks by giving each user
281+
their own subdomain `<user>.subdomain.example.org`.
282+
283+
It requires a wildcard DNS `*.subdomain.example.org` and SSL certificate.
284+
If you are using a Kubernetes ingress this must include hosts
285+
`subdomain.example.org` and `*.subdomain.example.org`.
286+
287+
The chart does not support the automatic creation of wildcard HTTPS certificates.
288+
Instead you should obtain a certificate from an external source,
289+
or install an ACME client such as cert-manager with the DNS-01 challenge.
290+
291+
See {ref}`jupyterhub:subdomains` in the JupyterHub documentation.
274292
extraFiles: &extraFiles
275293
type: object
276294
additionalProperties: false

0 commit comments

Comments
 (0)