mirror/php-rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-08-02 14:47:35 +02:00
Code Issues Releases Wiki Activity

Updated Docker (markdown)

Bockiii
2021-09-09 21:15:08 +02:00
parent 0ce48a7024
commit eeb54ca1ce
1 changed files with 10 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Docker.md

@@ -5,7 +5,7 @@ This guide is for people who want to run RSS Bridge using Docker. If you want to
```bash
docker create \
--name=rss-bridge \
--volume </path/to/whitelist.txt>:/app/whitelist.txt \
--volume </local/custom/path>:/config \
--publish 3000:80 \
rssbridge/rss-bridge:latest
```
@@ -15,7 +15,7 @@ And access it using `http://IP_Address:3000`. If you'd like to run a specific ve
```bash
docker create \
--name=rss-bridge \
--volume </path/to/whitelist.txt>:/app/whitelist.txt \
--volume </local/custom/path>:/config \
--publish 3000:80 \
rssbridge/rss-bridge:$version
```
@@ -28,18 +28,14 @@ You can run it using a `docker-compose.yml` as well:
version: '2'
services:
rss-bridge:
volumes:
- ./whitelist.txt:/app/whitelist.txt
build:
context: .
image: rssbridge/rss-bridge:latest
volumes:
- </local/custom/path>:/config
ports:
- 3000:80
restart: unless-stopped
```
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](Whitelisting).
# Container access and information
|Function|Command|
@@ -47,16 +43,10 @@ You can save this file as `docker-compose.yml`, create a `whitelist.txt` file ne
|Shell access (live container)|`docker exec -it rss-bridge /bin/sh`|
|Realtime container logs|`docker logs -f rss-bridge`|
# Adding custom bridges
If you want to add a bridge that is not part of [`/bridges`](https://github.com/RSS-Bridge/rss-bridge/tree/master/bridges), you can specify an additional layer to copy necessary files to the `rss-bridge` container.
# Adding custom bridges and configurations
If you want to add a bridge that is not part of [`/bridges`](https://github.com/RSS-Bridge/rss-bridge/tree/master/bridges), you can specify an additional folder to copy necessary files to the `rss-bridge` container.
_Here **root** is folder where `docker-compose.yml` and `whitelist.txt` reside._
1. Create `bridges` folder in root, copy your [bridges files](https://github.com/RSS-Bridge/rss-bridge/wiki/How-to-create-a-new-Bridge) there, and edit `whitelist.txt` to allow new bridges.
2. Add `dockerfile: Dockerfile` line under `build` section to `docker-compose.yml` (from the above).
3. Create `Dockerfile` in root:
```Dockerfile
FROM rssbridge/rss-bridge:latest
COPY ./bridges /app/bridges
```
4. Run `docker-compose up` to recreate service.
_Here **root** is folder where `docker-compose.yml` resides._
1. Create `custom` folder in root.
2. Copy your [bridges files](https://github.com/RSS-Bridge/rss-bridge/wiki/How-to-create-a-new-Bridge) to the `custom` folder. You can also add your custom [whitelist.txt](https://github.com/RSS-Bridge/rss-bridge/wiki/Whitelisting) file and your custom [config.ini.php](https://github.com/RSS-Bridge/rss-bridge/wiki/Custom-Configuration) to this folder.
3. Run `docker-compose up` to recreate service.