Skip to content

Commit

Permalink
Explain new options in README
Browse files Browse the repository at this point in the history
  • Loading branch information
dewey committed Aug 29, 2018
1 parent 210cdf7 commit 122bd24
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,24 @@ Returns the exported Prometheus metrics.
The following environment variables are available, they all have sensible defaults and don't need to be set explicity.

- `REFRESH_INTERVAL`: The interval in which feeds get rescraped in minutes (Default: 15)
- `CACHE_EXPIRATION`: The expiration time of the cache in minutes (Default: 30)
- `CACHE_EXPIRED_PURGE`: The interval at which the expired cache elements will be purged in minutes (Default: 60)
- `ENVIRONMENT`: Environment can be `prod` or `develop`. `develop` sets the loglevel to `info` (Default: `develop`)
- `PORT`: Port that feedbridge is running on (Default: `8080`)

There are two available storage backends right now. An in-memory and a disk backed implementation. Depending on which one you choose
there are additional options you can set.

- `STORAGE_BACKEND`: Set to `memory` to keep everything in-memory or `persistent` to persist the cache to disk. (Default: `memory`)

**In Memory**

- `CACHE_EXPIRATION`: The expiration time of the cache in minutes (Default: 30)
- `CACHE_EXPIRED_PURGE`: The interval at which the expired cache elements will be purged in minutes (Default: 60)

**Persistent**

- `STORAGE_PATH`: Set the storage location of the cache on disk. (Default: `./feedbridge-cache`)


### Run with Docker

You can change all these options in the included `docker-compose.yml` file and use `docker-compose -f docker-compose.yml up -d` to run the project.
Expand Down

0 comments on commit 122bd24

Please sign in to comment.