Handling logout

Author: Vismayak

docker-compose.dev.yml

@@ -67,6 +67,8 @@ services:
 
   postgres:
       image: postgres
+      networks:
+        - clowder2
       volumes:
         - postgres_data:/var/lib/postgresql/data
       environment:
@@ -79,6 +81,8 @@ services:
       volumes:
         - ./scripts/keycloak/clowder-realm-dev.json:/opt/keycloak/data/import/realm.json:ro
         - ./scripts/keycloak/clowder-theme/:/opt/keycloak/themes/clowder-theme/:ro
+      networks:
+        - clowder2
       command:
         - start-dev
         - --http-relative-path /keycloak

jupyterhub/.env-example

@@ -10,3 +10,5 @@ DOCKER_NETWORK_NAME="clowder2"
 DOCKER_NOTEBOOK_IMAGE="quay.io/jupyter/base-notebook:latest"
 DOCKER_NOTEBOOK_DIR="/home/jovyan/work"
 JUPYTERHUB_CRYPT_KEY=""
+CLOWDER_URL="localhost:3000"
+PROD_DEPLOYMENT="false"

jupyterhub/authenticator/customauthenticator/custom.py

@@ -34,6 +34,12 @@ class CustomTokenAuthenticator(Authenticator):
         help="the landing page login entry",
     )
 
+    landing_page_logout_url = Unicode(
+        os.environ.get("LANDING_PAGE_LOGOUT", ""),
+        config=True,
+        help="the landing page logout entry",
+    )
+
     keycloak_url = Unicode(
         os.environ.get("KEYCLOAK_URL", ""),
         config=True,
@@ -229,9 +235,9 @@ class CustomTokenLogoutHandler(LogoutHandler):
     async def handle_logout(self):
         # remove clowder token on logout
         self.log.info("Remove clowder token on logout")
-        error_msg = (
+        self.log.info(
             "You have logged out of Clowder system from Clowder . Please login again if you want to use "
             "Clowder components."
         )
         self.set_cookie(self.authenticator.auth_cookie_header, "")
-        self.redirect(f"{self.authenticator.landing_page_login_url}?error={error_msg}")
+        self.redirect(f"{self.authenticator.landing_page_logout_url}")

jupyterhub/jupyterhub_config.py

@@ -59,18 +59,36 @@
 c.KubeSpawner.args = ["--allow-root"]
 c.JupyterHub.authenticator_class = CustomTokenAuthenticator
 # TODO:Change this keycloak_url as required
-c.CustomTokenAuthenticator.keycloak_url = "http://%s/realms/%s/" % (
-    os.getenv("KEYCLOAK_HOSTNAME"),
-    os.getenv("KEYCLOAK_REALM"),
-)
+
 c.CustomTokenAuthenticator.auth_cookie_header = "Authorization"
 c.CustomTokenAuthenticator.auth_username_key = "preferred_username"
 c.CustomTokenAuthenticator.auth_uid_number_key = "uid_number"
 c.CustomTokenAuthenticator.enable_auth_state = True
 c.CustomTokenAuthenticator.auto_login = True
-c.CustomTokenAuthenticator.landing_page_login_url = "https://" + os.getenv(
-    "KEYCLOAK_HOSTNAME"
-)
+
+if os.getenv("PROD_DEPLOYMENT") == "true":
+    c.CustomTokenAuthenticator.keycloak_url = "https://%s/realms/%s/" % (
+        os.getenv("KEYCLOAK_HOSTNAME"),
+        os.getenv("KEYCLOAK_REALM"),
+    )
+    c.CustomTokenAuthenticator.landing_page_login_url = "https://" + os.getenv(
+        "KEYCLOAK_HOSTNAME"
+    )
+    c.CustomTokenAuthenticator.landing_page_logout_url = (
+        "https://" + os.getenv("CLOWDER_URL") + "/auth/logout"
+    )
+
+else:
+    c.CustomTokenAuthenticator.keycloak_url = "http://%s/realms/%s/" % (
+        os.getenv("KEYCLOAK_HOSTNAME"),
+        os.getenv("KEYCLOAK_REALM"),
+    )
+    c.CustomTokenAuthenticator.landing_page_login_url = "http://" + os.getenv(
+        "KEYCLOAK_HOSTNAME"
+    )
+    c.CustomTokenAuthenticator.landing_page_logout_url = (
+        "http://" + os.getenv("CLOWDER_URL") + "/auth/logout"
+    )
 
 c.JupyterHub.cookie_secret = os.getenv("JUPYTERHUB_CRYPT_KEY")