Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arska/calproxy

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/arska/calproxy
Owner: arska
Created: 2017-09-20T08:46:53.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2023-12-10T07:40:41.000Z (11 months ago)
Last Synced: 2023-12-10T08:27:10.695Z (11 months ago)
Language: Python
Size: 87.9 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Calproxy
[![Build Status](https://travis-ci.com/arska/calproxy.svg?branch=master)](https://travis-ci.com/arska/calproxy)

Simple HTTP proxy to proxy a fixed URL per requested path, optionally with HTTP basic auth.

Configuration through environment variables:
- (optional) URL_root: the URL to proxy through for /
- (optional) URL_asdf: the URL to proxy through for /asdf
- (optional) AUTHUSER: username to require for basic auth
- (optional) AUTHPASS: password to require for basic auth
- (optional) listenport: port to listen on, defaults to 8080
- (optional) cachetime: number of seconds to cache responses, defaults to 60*60s=1h

Authentication is only enforced if both AUTHUSER and AUTHPASS are specified

if there is no corresponding URL_path environment variable for a requested path the proxy returns an empty response (without requiring authentication, e.g. for a health check).

When a URL is requested the first time and the cache is empty an update is scheduled to happen in the background and an error (504 gateway timeout) is returned. As soon as the data is in the cache it is returned to requests. After the cachetime has expired each request will schedule an update in the background and old data will be returned until the update has completed. Only one update will run concurrently per target/upstream URL.

The special url /health is used to pre-fetch all URL_xxx.

The project is called calproxy because my use case is to proxy calendar availabilities where the upstream server takes about 2 minutes to export the calendar and the destination system times out after a few seconds.