hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-17 15:03:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

soften deprecation messages about ip/ports in favor of URLs

Browse Source 
These are not deprecated, bind_url is only a potentially more convenient/powerful alternative.
This commit is contained in:
Min RK
2018-05-07 13:51:35 +02:00
parent c3413bad78
commit b7a608fdfd
2 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/changelog.md
View File

@@ -47,12 +47,13 @@ and tornado < 5.0.
jupyterhub &>> /var/log/jupyterhub.log
- deprecate `JupyterHub.ip`, `JupyterHub.port`, `JupyterHub.base_url` config in favor of single `JupyterHub.bind_url` config.
- deprecate `JupyterHub.hub_ip`, `JupyterHub.hub_port` config
in favor of single `JupyterHub.hub_bind_url` config.
- Add `JupyterHub.bind_url` config for setting the full bind URL of the proxy.
Sets ip, port, base_url all at once.
- Add `JupyterHub.hub_bind_url` for setting the full host+port of the Hub.
`hub_bind_url` supports unix domain sockets, e.g.
`unix+http://%2Fsrv%2Fjupytrehub.sock`
- deprecate `JupyterHub.hub_connect_port` config in favor of `JupyterHub.hub_connect_url`.
- Deprecate `JupyterHub.hub_connect_port` config in favor of `JupyterHub.hub_connect_url`. `hub_connect_ip` is not deprecated
and can still be used in the common case where only the ip address of the hub differs from the bind ip.
#### Added

10
jupyterhub/app.py
View File

@@ -450,16 +450,20 @@ class JupyterHub(Application):
This is the internal port of the hub itself. It should never be accessed directly.
See JupyterHub.port for the public port to use when accessing jupyterhub.
It is rare that this port should be set except in cases of port conflict.
See also `hub_ip` for the ip and `hub_bind_url` for setting the full bind URL.
"""
).tag(config=True)
hub_ip = Unicode('127.0.0.1',
help="""The ip address for the Hub process to *bind* to.
By default, the hub listens on localhost only. This address must be accessible from
the proxy and user servers. You may need to set this to a public ip or '' for all
By default, the hub listens on localhost only. This address must be accessible from
the proxy and user servers. You may need to set this to a public ip or '' for all
interfaces if the proxy or user servers are in containers or on a different host.
See `hub_connect_ip` for cases where the bind and connect address should differ.
See `hub_connect_ip` for cases where the bind and connect address should differ,
or `hub_bind_url` for setting the full bind URL.
"""
).tag(config=True)