Merge pull request #162 from manics/dev

Add example jupyterhub_config.py

.gitignore

@@ -127,3 +127,7 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Other ignores
+jupyterhub.sqlite
+jupyterhub_cookie_secret

README.md

@@ -15,13 +15,17 @@ For example, this means it can be used as a JupyterHub spawner for BinderHub, wi
 
 ### Technical
 
-`subprocess.Popen` is used to make calls to Podman.
+`subprocess` is used to make calls to the Podman executable.
 See also this [issue](https://github.com/jupyterhub/dockerspawner/issues/360) on
 dockerspawner.
 
 ## Installation
 
-Via pip:
+Install latest release:
+
+    pip install podmanclispawner
+
+Install latest development branch:
 
     pip install git+https://github.com/manics/podmanclispawner
 
@@ -30,3 +34,8 @@ Via pip:
 ```python
 c.JupyterHub.spawner_class = 'podmancli'
 ```
+
+For a full example see [`example/jupyterhub_config.py`](example/jupyterhub_config.py):
+
+    cd example
+    jupyterhub -f jupyterhub_config.py

example/jupyterhub_config.py

@@ -0,0 +1,30 @@
+from os import getenv
+import socket
+from traitlets.config import get_config
+
+
+def get_host_ip():
+    """
+    Get the IP to connect to the host
+
+    If you're using Podman 5+ the default IP will not work, set HOST_IP
+    a non-default IP:
+    https://blog.podman.io/2024/03/podman-5-0-breaking-changes-in-detail/
+    """
+    host_ip = getenv("HOST_IP")
+    if not host_ip:
+        # IP associated with the default route https://stackoverflow.com/a/28950776
+        with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s:
+            # doesn't even have to be reachable
+            s.connect(("10.255.255.255", 1))
+            host_ip = s.getsockname()[0]
+    print(f"Host IP: {host_ip}")
+    return host_ip
+
+
+c = get_config()
+
+c.JupyterHub.authenticator_class = "dummy"
+c.JupyterHub.hub_connect_ip = get_host_ip()
+c.JupyterHub.spawner_class = "podmancli"
+c.PodmanCLISpawner.remove = True