Merge branch 'master' into fix-typo

Author: heatwole

.gitignore

@@ -1,3 +1,4 @@
 *.pyc
+*.egg-info/
 docs/_build
 node_modules

README.rst

@@ -2,13 +2,31 @@
 Jupyter Server Proxy
 ====================
 
+|ReadTheDocs badge| |Travis badge| |PyPI badge| |Conda badge| |NPM badge|
+
+.. |ReadTheDocs badge| image:: https://img.shields.io/readthedocs/jupyter-server-proxy?logo=read-the-docs
+   :target: https://jupyter-server-proxy.readthedocs.io/
+
+.. |Travis badge| image:: https://img.shields.io/travis/jupyterhub/jupyter-server-proxy/master.svg?logo=travis
+   :target: https://travis-ci.org/jupyterhub/jupyter-server-proxy
+
+.. |PyPI badge| image:: https://img.shields.io/pypi/v/jupyter-server-proxy.svg?logo=pypi
+   :target: https://pypi.python.org/pypi/jupyter-server-proxy
+
+.. |Conda badge| image:: https://img.shields.io/conda/vn/conda-forge/jupyter-server-proxy?logo=conda-forge
+   :target: https://anaconda.org/conda-forge/jupyter-server-proxy
+
+.. |NPM badge| image:: https://img.shields.io/npm/v/@jupyterlab/server-proxy.svg?logo=npm
+   :target: https://www.npmjs.com/package/@jupyterlab/server-proxy
+
 Jupyter Server Proxy lets you run arbitrary external processes (such
 as RStudio, Shiny Server, syncthing, PostgreSQL, etc) alongside your
 notebook, and provide authenticated web access to them.
 
-**Note:** This project used to be called **nbserverproxy**. if you have an older
-version of nbserverproxy installed, remember to uninstall it before install
-jupyter-server-proxy - otherwise they may conflict
+**Note:** This project used to be called **nbserverproxy**. As
+nbserverproxy is an older version of jupyter-server-proxy, uninstall
+nbserverproxy before installing jupyter-server-proxy to avoid
+conflicts.
 
 The primary use cases are:
 
@@ -32,18 +50,26 @@ Install
 pip
 ---
 
-``pip install jupyter-server-proxy``
+.. code-block::
+
+   pip install jupyter-server-proxy
 
 conda
 -----
 
-``conda install jupyter-server-proxy -c conda-forge``
+.. code-block::
+
+   conda install jupyter-server-proxy -c conda-forge
 
 src
 ---
 
-``pip install .``
+.. code-block::
+
+   pip install .
 
 **Note:** if installing from source in editable mode: ``setup.py develop/pip install -e``, please explicitly install the server extensions:
 
-``jupyter serverextension enable --sys-prefix jupyter_server_proxy``
+.. code-block::
+
+   jupyter serverextension enable --sys-prefix jupyter_server_proxy

contrib/code-server-traitlet/README.md

@@ -0,0 +1,5 @@
+## code-server-traitlet
+
+Create a code-server launcher [via traitlet](https://jupyter-server-proxy.readthedocs.io/en/latest/server-process.html#specifying-config-via-traitlets).
+
+Via https://github.com/betatim/vscode-binder.

contrib/code-server-traitlet/jupyter_notebook_config.py

@@ -0,0 +1,15 @@
+c.ServerProxy.servers = {
+  'code-server': {
+    'command': [
+      'code-server',
+        '--no-auth',
+        '--disable-telemetry',
+        '--allow-http',
+        '--port={port}'
+    ],
+    'timeout': 20,
+    'launcher_entry': {
+      'title': 'VS Code'
+    }
+  }
+}

contrib/template/{{cookiecutter.project_name}}/jupyter_{{cookiecutter.project_name}}_proxy/__init__.py

@@ -12,6 +12,6 @@ def setup_{{cookiecutter.project_name}}():
         'environment': {},
         'launcher_entry': {
             'title': '{{cookiecutter.project_name}}',
-            'icon_url': os.path.join(os.path.dirname(os.path.abspath(__file__)), 'icons', '{{cookiecutter.project_name}}.svg')
+            'icon_path': os.path.join(os.path.dirname(os.path.abspath(__file__)), 'icons', '{{cookiecutter.project_name}}.svg')
         }
-    }
+    }

docs/arbitrary-ports.rst renamed to docs/arbitrary-ports-hosts.rst

@@ -1,8 +1,8 @@
 .. _arbitrary-ports:
 
-=========================
-Accessing Arbitrary Ports
-=========================
+==================================
+Accessing Arbitrary Ports or Hosts
+==================================
 
 If you already have a server running on localhost listening on
 a port, you can access it through the notebook at
@@ -15,6 +15,11 @@ URL in the request.
 
 This works for all ports listening on the local machine.
 
+You can also specify arbitrary hosts in order to proxy traffic from
+another machine on the network ``<notebook-base>/proxy/<host>:<port>``.
+
+For security reasons the host must match an entry in the whitelist in your configuration.
+
 With JupyterHub
 ===============
 
@@ -38,7 +43,7 @@ Without JupyterHub
 ==================
 
 A very similar set up works when you don't use JupyterHub. You
-can construct the URL with ``<notebook-url>/proxy/<port>``. 
+can construct the URL with ``<notebook-url>/proxy/<port>``.
 
 If your notebook url is ``http://localhost:8888`` and you have
 a process running listening on port 8080, you can access it with

docs/index.rst

@@ -20,7 +20,7 @@ The primary use cases are:
 #. Allow access from frontend javascript (in classic notebook or
    JupyterLab extensions) to access web APIs of other processes
    running locally in a safe manner. This is used by the `JupyterLab
-   extension <https://github.com/dask/dask-labextension>`_ for 
+   extension <https://github.com/dask/dask-labextension>`_ for
    `dask <https://dask.org/>`_.
 
 
@@ -33,7 +33,7 @@ Contents
    install
    server-process
    launchers
-   arbitrary-ports
+   arbitrary-ports-hosts
 
 
 Convenience packages for popular applications

docs/launchers.rst

@@ -26,7 +26,7 @@ to provide launcher icons for registered server processes.
 
 .. code:: bash
 
-   jupyter labextension install jupyterlab-server-proxy
+   jupyter labextension install @jupyterlab/server-proxy
 
 This should provide icons for each registered process in the main
 JupyterLab launcher

docs/server-process.rst

@@ -90,6 +90,13 @@ pairs.
      automatically select an unused port.
 
 
+#. **mappath**
+
+     Map request paths to proxied paths.
+     Either a dictionary of request paths to proxied paths,
+     or a callable that takes parameter ``path`` and returns the proxied path.
+
+
 #. **launcher_entry**
 
    A dictionary with options on if / how an entry in the classic Jupyter Notebook
@@ -167,7 +174,7 @@ the command is started
 Specifying config via traitlets
 ===============================
 
-[Traitlets](https://traitlets.readthedocs.io/) are the configuration
+`Traitlets <https://traitlets.readthedocs.io/>`_ are the configuration
 mechanism used by Jupyter Notebook. It can take config in Python
 and we can use that to specify Server Processes - including functions
 if we want tighter control over what process is spawned.

jupyter_server_proxy/__init__.py

@@ -29,7 +29,7 @@ def load_jupyter_server_extension(nbapp):
     nbapp.web_app.add_handlers('.*', server_handlers)
 
     # Set up default handler
-    setup_handlers(nbapp.web_app)
+    setup_handlers(nbapp.web_app, serverproxy.host_whitelist)
 
     launcher_entries = []
     icons = {}
@@ -40,4 +40,4 @@ def load_jupyter_server_extension(nbapp):
     nbapp.web_app.add_handlers('.*', [
         (ujoin(base_url, 'server-proxy/servers-info'), ServersInfoHandler, {'server_processes': server_proccesses}),
         (ujoin(base_url, 'server-proxy/icon/(.*)'), IconHandler, {'icons': icons})
-    ])
+    ])