Skip to content

Commit

Permalink
Latest naming convention for compose
Browse files Browse the repository at this point in the history
  • Loading branch information
heussd committed Jun 21, 2024
1 parent 7f39610 commit 35c9fd2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,30 @@ This is a containerized version of [fivefilters full-text-rss](https://www.fivef

Not affiliated with [fivefilters.org](http://fivefilters.org/). The Dockerfile is licensed under [MIT conditions](LICENSE).


## User Guide

- Use the following [docker-compose.yml](docker-compose.yml)
- Use the following [compose.yml](compose.yml)

```yaml
services:
fullfeedrss:
image: "heussd/fivefilters-full-text-rss:latest"
environment:
# Leave empty to disable admin section
- FTR_ADMIN_PASSWORD=
volumes:
- "rss-cache:/var/www/html/cache/rss"
ports:
- "80:80"
fullfeedrss:
image: 'heussd/fivefilters-full-text-rss:latest'
environment:
# Leave empty to disable admin section
- FTR_ADMIN_PASSWORD=
volumes:
- 'rss-cache:/var/www/html/cache/rss'
ports:
- '80:80'
volumes:
rss-cache:
rss-cache:
```
- Start it with `docker-compose up`
- Visit [http://localhost:80](http://localhost:80) for the integrated web UI
- Start it with `docker-compose up`
- Visit [http://localhost:80](http://localhost:80) for the integrated web UI

![](webui.png)

- Interesting endpoints (see tab [Request & Response](http://localhost/#request)):
- Article extraction: `http://localhost/extract.php?url=[url]`
- Feed conversion: `http://localhost/makefulltextfeed.php?url=[url]`
- Interesting endpoints (see tab [Request & Response](http://localhost/#request)):
- Article extraction: `http://localhost/extract.php?url=[url]`
- Feed conversion: `http://localhost/makefulltextfeed.php?url=[url]`
File renamed without changes.

0 comments on commit 35c9fd2

Please sign in to comment.