https://github.com/globocom/configurable-http-proxy-redis-backend

Redis Backend for Jupyter's Configurable Proxy
https://github.com/globocom/configurable-http-proxy-redis-backend

datascience javascript jupyterhub nodejs redis

Last synced: over 1 year ago
JSON representation

Redis Backend for Jupyter's Configurable Proxy

• Host: GitHub
• URL: https://github.com/globocom/configurable-http-proxy-redis-backend
• Owner: globocom
• License: bsd-3-clause
• Created: 2017-10-06T14:56:37.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-10-25T07:10:34.000Z (almost 4 years ago)
• Last Synced: 2025-04-02T23:01:34.822Z (over 1 year ago)
• Topics: datascience, javascript, jupyterhub, nodejs, redis
• Language: JavaScript
• Size: 85 KB
• Stars: 12
• Watchers: 11
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Redis Backend for Jupyter's Configurable Proxy

[![Build Status](https://travis-ci.org/globocom/configurable-http-proxy-redis-backend.svg?branch=master)](https://travis-ci.org/globocom/configurable-http-proxy-redis-backend) [![npm version](https://badge.fury.io/js/configurable-http-proxy-redis-backend.svg)](https://badge.fury.io/js/configurable-http-proxy-redis-backend)

*configurable-http-proxy-redis-backend* is an extension for [configurable-http-proxy](https://github.com/jupyterhub/configurable-http-proxy). It allows routes to be saved on [redis](https://redis.io).

# 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](https://github.com/luin/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