https://github.com/christian-draeger/caching-https-proxy
https://github.com/christian-draeger/caching-https-proxy
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/christian-draeger/caching-https-proxy
- Owner: christian-draeger
- License: mit
- Created: 2022-05-19T07:20:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-21T12:52:10.000Z (over 3 years ago)
- Last Synced: 2024-12-25T19:23:55.386Z (9 months ago)
- Language: Dockerfile
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# caching-https-proxy
## Why
tbd
## How it works
tbd
## Usage
### Configuration via environment variables
| **Env Var** | **default value** | **description** |
|--------------------------|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| EXTERNAL_HOST | github.com | The host name you want to cache calls to. |
| PORT | 8080 | The internal Port of the Proxy |
| ROUTE | / | Used route prefix. |
| CACHE_PATH | /tmp/cache | The local disk directory where the cached resources a saved. |
| CACHE_KEY_ZONE_SIZE | 10m | keys_zone sets up a shared memory zone for storing the cache keys and metadata such as usage timers. Having a copy of the keys in memory enables the caching-https-proxy to quickly determine if a request is a HIT or a MISS without having to go to disk, greatly speeding up the check. A 1‑MB zone can store data for about 8,000 keys, so the 10‑MB zone configured in the example can store data for about 80,000 keys. |
| CACHE_MAX_SIZE | 1g | Sets the upper limit of the size of the cache. When the cache size reaches the limit, a process called the cache manager removes the files that were least recently used to bring the cache size back under the limit. |
| CACHE_ENTRY_INACTIVE_TTL | 72h | Evict least recently used entries (entries without a cache hit) after a given time. |
| CACHE_ENTRY_ACTIVE_TTL | 30d | Evict entries older than a given time. |
## Deployment
### Docker
```shell
docker pull draeger/caching-https-proxy
docker run -p 8000:8080 draeger/caching-https-proxy
```
### Kubernetes via Helm Chart
Since the caching-https-proxy is based on nginx the caching-https-proxy provides a ready to use [helm chart](deployment/chart) that uses
the [bitnami/nginx](https://artifacthub.io/packages/helm/bitnami/nginx) as a base chart.
to deploy the caching-https-proxy directly to kubernetes using helm just run:
```shell
cd deployment/chart
helm upgrade --install my-caching-https-proxy . -f ./values.yaml
```
to check what would be installed you can do a helm dry run that will print manifest to console out:
```shell
helm install my-caching-https-proxy ./deployment/chart --dry-run --debug
```
### Heroku
tbd
## Development
To build the caching-https-proxy docker image on your local machine run following command from projects root:
```shell
docker build -t caching-https-proxy:latest ./source
```
run local docker image on a given host machines port (e.g. 8000):
```shell
docker run -p 8000:8080 caching-https-proxy
```
ssh into running container:
```shell
docker exec -it /bin/sh
```