Skip to content

Commit d91dbde

Browse files
docs(rss-proxy on docker : specifying requirements and tips in order to work) (#76)
1 parent 2e51839 commit d91dbde

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If you look for features below, you have to use [feedless](https://github.com/da
2828
# Changelog
2929
See [here](./changelog.md)
3030

31-
## Quickstart using docker
31+
## Quickstart installation using docker
3232
If you have [docker](https://docs.docker.com/install/) or [podman](https://podman.io/getting-started/installation) installed, do this
3333

3434
```
@@ -40,6 +40,12 @@ docker run -p 8080:8080 -e APP_API_GATEWAY_URL=https://foo.bar -it damoeb/rss-pr
4040

4141
Then open [localhost:8080](http://localhost:8080) in the browser.
4242

43+
## Understanding Docker requirements
44+
For RSS-Proxy to work with your Docker environment, you must ensure :
45+
- that you expose port 8080 on the container
46+
- that the rss-proxy container share a common network with the RSS reader app you are (probably self-hosting). The Docker `bridge` network is native to Docker in order to allow you to connect two containers on the same network.
47+
- then you need to personalize the `APP_API_GATEWAY_URL` : it must point to the IP of rss-proxy on the shared network selected and the container opened port (e.g : 192.172.0.3:8080). If you have a your rss-proxy runs under a named address you can simply point to that named address
48+
4349
## Legacy Version 1
4450
If you are interested in running the first prototype, this is how you do it.
4551

0 commit comments

Comments
 (0)