diff --git a/docs/source/install.md b/docs/source/install.md index 3302e2a9..08c08f3b 100644 --- a/docs/source/install.md +++ b/docs/source/install.md @@ -96,7 +96,7 @@ you can load a specific config file and start JupyterHub using: $ jupyterhub -f /path/to/jupyterhub_config.py ``` -There is an example configuration file [here](https://github.com/jupyterhub/traefik-proxy/blob/HEAD/examples/jupyterhub_config_toml.py) that configures JupyterHub to run with [TraefikRedisProxy](redis) as the proxy and uses dummyauthenticator and simplespawner to enable testing without administrative privileges. +There is an example configuration file [here](https://github.com/jupyterhub/traefik-proxy/blob/HEAD/examples/jupyterhub_config_redis.py) that configures JupyterHub to run with [TraefikRedisProxy](redis) as the proxy and uses dummyauthenticator and simplespawner to enable testing without administrative privileges. In _jupyterhub_config.py_: diff --git a/examples/jupyterhub_config_etcd.py b/examples/jupyterhub_config_etcd.py index e28f6395..9f145359 100644 --- a/examples/jupyterhub_config_etcd.py +++ b/examples/jupyterhub_config_etcd.py @@ -4,8 +4,6 @@ configures jupyterhub with dummyauthenticator and simplespawner to enable testing without administrative privileges. - -requires jupyterhub 1.0.dev """ c = get_config() # noqa @@ -17,3 +15,4 @@ # use dummy and simple auth/spawner for testing c.JupyterHub.authenticator_class = "dummy" c.JupyterHub.spawner_class = "simple" +c.JupyterHub.ip = "127.0.0.1" diff --git a/examples/jupyterhub_config_redis.py b/examples/jupyterhub_config_redis.py new file mode 100644 index 00000000..7485e6bb --- /dev/null +++ b/examples/jupyterhub_config_redis.py @@ -0,0 +1,18 @@ +"""sample jupyterhub config file for testing + +configures jupyterhub to run with traefik and redis. + +configures jupyterhub with dummyauthenticator and simplespawner +to enable testing without administrative privileges. +""" + +c = get_config() # noqa + +c.JupyterHub.proxy_class = "traefik_redis" +c.TraefikProxy.traefik_api_username = "admin" +c.TraefikProxy.traefik_api_password = "admin" + +# use dummy and simple auth/spawner for testing +c.JupyterHub.authenticator_class = "dummy" +c.JupyterHub.spawner_class = "simple" +c.JupyterHub.ip = "127.0.0.1" diff --git a/examples/jupyterhub_config_toml.py b/examples/jupyterhub_config_toml.py index 30207bcf..d0565a6e 100644 --- a/examples/jupyterhub_config_toml.py +++ b/examples/jupyterhub_config_toml.py @@ -4,8 +4,6 @@ configures jupyterhub with dummyauthenticator and simplespawner to enable testing without administrative privileges. - -requires jupyterhub 1.0.dev """ c = get_config() # noqa @@ -18,3 +16,4 @@ # use dummy and simple auth/spawner for testing c.JupyterHub.authenticator_class = "dummy" c.JupyterHub.spawner_class = "simple" +c.JupyterHub.ip = "127.0.0.1"