Skip to content

Commit

Permalink
add missing example redis config
Browse files Browse the repository at this point in the history
and restores link to it
  • Loading branch information
minrk committed Nov 6, 2024
1 parent f60ce12 commit 7ebab5d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_:

Expand Down
3 changes: 1 addition & 2 deletions examples/jupyterhub_config_etcd.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"
18 changes: 18 additions & 0 deletions examples/jupyterhub_config_redis.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""sample jupyterhub config file for testing
configures jupyterhub to run with traefik and etcd.
configures jupyterhub with dummyauthenticator and simplespawner
to enable testing without administrative privileges.
"""

c = get_config() # noqa

c.JupyterHub.proxy_class = "traefik_redis"
c.TraefikEtcdProxy.traefik_api_username = "admin"
c.TraefikEtcdProxy.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"
3 changes: 1 addition & 2 deletions examples/jupyterhub_config_toml.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"

0 comments on commit 7ebab5d

Please sign in to comment.