Compare commits
2 Commits
18ec10fe44
...
9d062ef24b
Author | SHA1 | Date |
---|---|---|
pictuga | 9d062ef24b | |
pictuga | 447f62dc45 |
29
README.md
29
README.md
|
@ -73,7 +73,7 @@ You may also need:
|
||||||
Build & run
|
Build & run
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker build --tag morss https://git.pictuga.com/pictuga/morss.git
|
docker build --tag morss https://git.pictuga.com/pictuga/morss.git --no-cache --pull
|
||||||
docker run -p 8080:8080 morss
|
docker run -p 8080:8080 morss
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -91,16 +91,10 @@ services:
|
||||||
Then execute
|
Then execute
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker-compose build
|
docker-compose build --no-cache --pull
|
||||||
docker-compose up
|
docker-compose up
|
||||||
```
|
```
|
||||||
|
|
||||||
To update:
|
|
||||||
|
|
||||||
- To get the latest code from the git repository, add `--no-cache` to the build
|
|
||||||
commands
|
|
||||||
- To update the base image (`alpine:latest`), add `--pull` to the build commands
|
|
||||||
|
|
||||||
## Run
|
## Run
|
||||||
|
|
||||||
morss will auto-detect what "mode" to use.
|
morss will auto-detect what "mode" to use.
|
||||||
|
@ -346,21 +340,22 @@ Generic:
|
||||||
- `DEBUG=1`: to have some feedback from the script execution. Useful for
|
- `DEBUG=1`: to have some feedback from the script execution. Useful for
|
||||||
debugging.
|
debugging.
|
||||||
- `IGNORE_SSL=1`: to ignore SSL certs when fetch feeds and articles
|
- `IGNORE_SSL=1`: to ignore SSL certs when fetch feeds and articles
|
||||||
- `DELAY` sets the browser cache delay, only for HTTP clients
|
- `DELAY` (seconds) sets the browser cache delay, only for HTTP clients
|
||||||
- `TIMEOUT` sets the HTTP timeout when fetching rss feeds and articles
|
- `TIMEOUT` (seconds) sets the HTTP timeout when fetching rss feeds and articles
|
||||||
|
|
||||||
When parsing long feeds, with a lot of items (100+), morss might take a lot of
|
When parsing long feeds, with a lot of items (100+), morss might take a lot of
|
||||||
time to parse it, or might even run into a memory overflow on some shared
|
time to parse it, or might even run into a memory overflow on some shared
|
||||||
hosting plans (limits around 10Mb), in which case you might want to adjust the
|
hosting plans (limits around 10Mb), in which case you might want to adjust the
|
||||||
below settings via environment variables.
|
below settings via environment variables.
|
||||||
|
|
||||||
- `MAX_TIME` sets the maximum amount of time spent *fetching* articles, more
|
- `MAX_TIME` (seconds) sets the maximum amount of time spent *fetching*
|
||||||
time might be spent taking older articles from cache. `-1` for unlimited.
|
articles, more time might be spent taking older articles from cache. `-1` for
|
||||||
|
unlimited.
|
||||||
- `MAX_ITEM` sets the maximum number of articles to fetch. `-1` for unlimited.
|
- `MAX_ITEM` sets the maximum number of articles to fetch. `-1` for unlimited.
|
||||||
More articles will be taken from cache following the nexts settings.
|
More articles will be taken from cache following the nexts settings.
|
||||||
- `LIM_TIME` sets the maximum amount of time spent working on the feed (whether
|
- `LIM_TIME` (seconds) sets the maximum amount of time spent working on the feed
|
||||||
or not it's already cached). Articles beyond that limit will be dropped from the
|
(whether or not it's already cached). Articles beyond that limit will be dropped
|
||||||
feed. `-1` for unlimited.
|
from the feed. `-1` for unlimited.
|
||||||
- `LIM_ITEM` sets the maximum number of article checked, limiting both the
|
- `LIM_ITEM` sets the maximum number of article checked, limiting both the
|
||||||
number of articles fetched and taken from cache. Articles beyond that limit will
|
number of articles fetched and taken from cache. Articles beyond that limit will
|
||||||
be dropped from the feed, even if they're cached. `-1` for unlimited.
|
be dropped from the feed, even if they're cached. `-1` for unlimited.
|
||||||
|
@ -379,8 +374,8 @@ To limit the size of the cache:
|
||||||
- `CACHE_SIZE` sets the target number of items in the cache (further items will
|
- `CACHE_SIZE` sets the target number of items in the cache (further items will
|
||||||
be deleted but the cache might be temporarily bigger than that). Defaults to 1k
|
be deleted but the cache might be temporarily bigger than that). Defaults to 1k
|
||||||
entries.
|
entries.
|
||||||
- `CACHE_LIFESPAN` sets how often the cache must be trimmed (i.e. cut down to
|
- `CACHE_LIFESPAN` (seconds) sets how often the cache must be trimmed (i.e. cut
|
||||||
the number of items set in `CACHE_SIZE`). Defaults to 1min.
|
down to the number of items set in `CACHE_SIZE`). Defaults to 1min.
|
||||||
|
|
||||||
### Content matching
|
### Content matching
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue