Add indexpage option

Author: manics

jupyter_server_proxy/config.py

@@ -9,7 +9,7 @@
 from collections import namedtuple
 from .utils import call_with_asked_args
 
-def _make_serverproxy_handler(name, command, environment, timeout, absolute_url, port):
+def _make_serverproxy_handler(name, command, environment, timeout, absolute_url, port, indexpage):
     """
     Create a SuperviseAndProxyHandler subclass with given parameters
     """
@@ -21,6 +21,7 @@ def __init__(self, *args, **kwargs):
             self.proxy_base = name
             self.absolute_url = absolute_url
             self.requested_port = port
+            self.indexpage = indexpage
 
         @property
         def process_args(self):
@@ -82,6 +83,7 @@ def make_handlers(base_url, server_processes):
             sp.timeout,
             sp.absolute_url,
             sp.port,
+            sp.indexpage,
         )
         handlers.append((
             ujoin(base_url, sp.name, r'(.*)'), handler, dict(state={}),
@@ -93,7 +95,7 @@ def make_handlers(base_url, server_processes):
 
 LauncherEntry = namedtuple('LauncherEntry', ['enabled', 'icon_path', 'title'])
 ServerProcess = namedtuple('ServerProcess', [
-    'name', 'command', 'environment', 'timeout', 'absolute_url', 'port', 'launcher_entry'])
+    'name', 'command', 'environment', 'timeout', 'absolute_url', 'port', 'indexpage', 'launcher_entry'])
 
 def make_server_process(name, server_process_config):
     le = server_process_config.get('launcher_entry', {})
@@ -104,6 +106,7 @@ def make_server_process(name, server_process_config):
         timeout=server_process_config.get('timeout', 5),
         absolute_url=server_process_config.get('absolute_url', False),
         port=server_process_config.get('port', 0),
+        indexpage=server_process_config.get('indexpage', ''),
         launcher_entry=LauncherEntry(
             enabled=le.get('enabled', True),
             icon_path=le.get('icon_path'),
@@ -144,6 +147,11 @@ class ServerProxy(Configurable):
           port
             Set the port that the service will listen on. The default is to automatically select an unused port.
 
+          indexpage
+            If the root of the service is requested return this page instead.
+            This is often referred to in web-server configurations as the index
+            page.
+
           launcher_entry
             A dictionary of various options for entries in classic notebook / jupyterlab launchers.
 

jupyter_server_proxy/handlers.py

@@ -340,6 +340,7 @@ class SuperviseAndProxyHandler(LocalProxyHandler):
 
     def __init__(self, *args, **kwargs):
         self.requested_port = 0
+        self.indexpage = ''
         super().__init__(*args, **kwargs)
 
     def initialize(self, state):
@@ -435,6 +436,8 @@ async def ensure_process(self):
     async def proxy(self, port, path):
         if not path.startswith('/'):
             path = '/' + path
+        if self.indexpage and (path == '/' or path.startswith == '/?'):
+            path = '/' + self.indexpage + path[1:]
 
         await self.ensure_process()