Code Monkey home page Code Monkey logo

jupyter-codeserver-proxy's Introduction

build

jupyter-codeserver-proxy

Integrate code-server in your Jupyter environment for an fast, feature-rich and easy to use remote desktop in the browser.


ATTENTION:
code-server has no official support for passing the password/token via url-parameters. Sad thing, a pull request was not merged [more]. Hence, we need to disable authentication at the moment completly with --auth=none [more]. This allows any user who can access localhost:port of the machine running the code-server to use it - even if he is not authorized to do so. An alternative solution to close this security hole might be to use unix sockets instead of ports. As soon as this is fully supported by jupyter-server-proxy we will switch [more].


Jupyter-codeserver-proxy example

Requirements

  • Python 3.6+
  • Jupyter Notebook 6.0+
  • JupyterLab >= 3.x
  • jupyter-server-proxy >= 3.1.0

This package executes the code-server command.
It tries to find the code-server executable checking the following:

    1. environment variable $CODESERVER_BIN
    1. <dir-of-__init__.py>/bin/code-server
    1. which code-server (searching standard $PATH)
    1. special locations:
      • /opt/codeserver/bin/code-server

Install

Create and Activate Environment

virtualenv -p python3 venv
source venv/bin/activate

Install jupyter-codeserver-proxy

pip install git+https://github.com/FZJ-JSC/jupyter-codeserver-proxy.git

Enable jupyter-codeserver-proxy extensions

For Jupyter Classic, activate the jupyter-server-proxy extension:

jupyter serverextension enable --sys-prefix jupyter_server_proxy

For Jupyter Lab, install the @jupyterlab/server-proxy extension:

jupyter labextension install @jupyterlab/server-proxy
jupyter lab build

Start Jupyter Classic or Jupyter Lab

Click on the code-server icon from the Jupyter Lab Launcher or the code-server item from the New dropdown in Jupyter Classic.
Connect to your database as instructed in the Quickstart section.

Configuration

This package calls code-server with a bunch of settings.
You have to modify setup_codeserver() in jupyter_codeserver_proxy/__init__.py for change.

Credits

License

BSD 3-Clause

jupyter-codeserver-proxy's People

Contributors

jhgoebbert avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.