Redis Backend(support redis cluster) for Jupyter's Configurable Proxy

configurable-http-proxy-redis-backend is an extension for configurable-http-proxy. It allows routes to be saved on redis.

Install

configurable-http-proxy-redis-backend requires Node.js ≥ v6.0.0 and configurable-http-proxy ≥ v3.1.0.

To install configurable-http-proxy-redis-backend:

npm install configurable-http-proxy configurable-http-proxy-redis-backend

Usage

First of all, you must export CONFIGURABLE_PROXY_REDIS_URI environment variable. URI should follow the format specified in ioredis.

 export CONFIGURABLE_PROXY_REDIS_URI=redis://host.myredis:6379

After installing and exporting CONFIGURABLE_PROXY_REDIS_URI, you should be able to use --storage-backend configurable-http-proxy-redis-backend argument.

configurable-http-proxy \
    --ip 0.0.0.0 \
    --port 8043 \
    --api-ip 0.0.0.0 \
    --api-port 8044 \
    --default-target http://127.0.0.1:8081 \
    --error-target http://127.0.0.1:8081/hub/error \
    --log-level debug \
    --storage-backend configurable-http-proxy-redis-backend

Redis URL and Sentinel URL

Currently, we are supporting the follow URL formats:

• redis://host:port/[name]

• redis://:auth@host:port/[name]

• sentinel://host:port/master-name

• sentinel://host1:port,host2:port/master-name

• sentinel://:auth@host1:port,host2:port/master-name