container-images
/
miniflux-filter
2
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

README: highlighting

This commit is contained in:
Michael Grote 2021-11-02 19:47:22 +01:00
parent 6c2b296c15
commit 6adc48d77f
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -23,7 +23,7 @@
4. ````docker-compose up````
#### example docker-compose
```
```yaml
version: '3.2'
services:
mf-filter:
@ -41,7 +41,7 @@ services:
```
#### example filter-file
```
```ini
<part_of_url>:<search string, anything goes, but not :>
sueddeutsche.de:FC Bayern
heise.de:software-architektur.tv
@ -64,10 +64,10 @@ If `MF_DEBUG` is set to `1`, `miniflux-filter` will print extra output to stdou
#### Exit-Codes
| RC | Description |
| -- | -- |
| 1 | $MF_FILTERLIST_FIL not found |
| 2 | $MF_AUTH_TOKEN not set |
| 3 | $MF_API_URL not set |
| 4 | $MF_FILTERLIST_FILE is a dir |
| 1 | `$MF_FILTERLIST_FILE` not found |
| 2 | `$MF_AUTH_TOKEN` not set |
| 3 | `$MF_API_URL` not set |
| 4 | `$MF_FILTERLIST_FILE` is a dir |
| 5 | `jq` is not installed |
| 6 | `curl` is not installed |
| 7 | could not connect to `miniflux` |
@ -77,7 +77,7 @@ If `MF_DEBUG` is set to `1`, `miniflux-filter` will print extra output to stdou
## Build Container
```
```shell
git clone https://git.mgrote.net/mg/miniflux-filter
cd miniflux-filter
export MF_DOCKER_HUB_PASS=<your_docker_hub_pass>
@ -85,5 +85,6 @@ export MF_DOCKER_HUB_USER=<your_docker_hub_user>
./build.sh
```
## License
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](./LICENSE) file for details.