diff --git a/Readme.md b/Readme.md index 1604224..4b291fb 100644 --- a/Readme.md +++ b/Readme.md @@ -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]` diff --git a/docker-compose.yml b/compose.yml similarity index 100% rename from docker-compose.yml rename to compose.yml