Fix location of subdomain_host in schema

jupyterhub · Oct 21, 2024 · 7152952 · 7152952
1 parent 9658c24
commit 7152952
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/docs/source/administrator/security.md b/docs/source/administrator/security.md
@@ -496,7 +496,7 @@ This would restrict the access to only two IP addresses: `111.111.111.111` and `
 
 You can reduce the chance of cross-origin attacks by giving each user
 their own subdomain `<user>.jupyter.example.org`.
-This requires setting [`hub.config.subdomain_host`](schema_hub.config.subdomain_host), creating a wildcard DNS record `*.jupyter.example.org`, and creating a wildcard SSL certificate.
+This requires setting [`subdomain_host`](schema_hub.config.JupyterHub.subdomain_host), creating a wildcard DNS record `*.jupyter.example.org`, and creating a wildcard SSL certificate.
 
 ```yaml
 hub:

diff --git a/jupyterhub/values.schema.yaml b/jupyterhub/values.schema.yaml
@@ -272,15 +272,19 @@ properties:
           dictionaries are updated.
           ```
         properties:
-          subdomain_host:
-            type: string
-            description: |
-              The subdomain to use for hosting singleuser servers.
+          JupyterHub:
+            type: object
+            additionalProperties: true
+            properties:
+              subdomain_host:
+                type: string
+                description: |
+                  The subdomain to use for hosting singleuser servers.
 
-              This helps protect against some cross-origin attacks by giving each user
-              their own subdomain `<user>.jupyter.example.org`.
+                  This helps protect against some cross-origin attacks by giving each user
+                  their own subdomain `<user>.jupyter.example.org`.
 
-              See {ref}`jupyterhub_subdomains`.
+                  See {ref}`jupyterhub_subdomains`.
       extraFiles: &extraFiles
         type: object
         additionalProperties: false