diff --git a/Docker.md b/Docker.md new file mode 100644 index 0000000..0bd94b5 --- /dev/null +++ b/Docker.md @@ -0,0 +1,45 @@ +## Setup + +```bash +docker create \ +--name=rss-bridge \ +-v :/app/public/whitelist.txt \ +-p 3000:80 \ +rssbridge/rss-bridge:latest +``` + +And access it using `http://IP_Address:3000`. If you'd like to run a specific version, you can run it by: + +```bash +docker create \ +--name=rss-bridge \ +-v :/app/public/whitelist.txt \ +-p 3000:80 \ +rssbridge/rss-bridge:$version +``` + +Where you can get the versions published to Docker Hub at https://hub.docker.com/r/rssbridge/rss-bridge/tags/. The server runs on port 80 internally, and you can publish it on a different port (change 3000 to your choice). + +You can run it using a `docker-compose.yml` as well: + +```yml +version: '2' +services: + rss-bridge: + volumes: + - whitelist.txt:/app/public/whitelist.txt + build: + context: . + image: rssbridge/rss-bridge:latest + ports: + - 3000:80 +``` + +You can save this file as `docker-compose.yml`, create a `whitelist.txt` file next to it (just leave the file empty) before running it using `docker-compose up`. Once it gets running, you can edit the `whitelist.txt` as per the plugins you want to run. + +# Container access and information + +|Function|Command| +|===|===| +|Shell access (live container)|`docker exec -it rss-bridge /bin/sh`| +|Realtime container logs|`docker logs -f rss-bridge`| \ No newline at end of file