Skip to content

Commit ab34761

Browse files
Apply suggestions from code review
Co-authored-by: Yuvi Panda <yuvipanda@gmail.com>
1 parent 780f022 commit ab34761

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

jupyterhub_ssh/__init__.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,20 @@ class JupyterHubSSH(Application):
226226
"",
227227
help="""
228228
URL of JupyterHub's proxy to connect to.
229+
230+
`jupyterhub-ssh` needs to be able to connect to both the
231+
JupyterHub API and to the user's server. If running in
232+
the same cluster as the JupyterHub, this should point to
233+
the `proxy-public` service. When running outside the same
234+
cluster, this should be set to the user accessible URL of
235+
the hub.
229236
230237
*Must* be set.
238+
239+
Examples:
240+
241+
`http://proxy-public` (in same cluster & namespace as jupyterhub)
242+
`https://my-hub-url.com` (when running outside the cluster)
231243
""",
232244
config=True,
233245
)

0 commit comments

Comments
 (0)