mirror/RSS-Bridge.rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-07-23 12:15:23 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: improve docker docs (#4183)

Browse source 
* docs: improve docker docs

* fix: cleanup and remove duplicate docker instructions
This commit is contained in:
Dag 2024-08-01 23:36:14 +02:00 • committed by GitHub
parent d050fe9a9b
commit 0051e0fcdd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 53 additions and 126 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/04_For_Developers/07_Development_Environment_Setup.md
View file

@ -1,39 +1,5 @@
These are examples of how to setup a local development environment to add bridges, improve the docs, etc.
## Docker
The following can serve as an example for using docker:
```
# create a new directory
mkdir rss-bridge-contribution
cd rss-bridge-contribution
# clone the project into a subfolder
git clone https://github.com/RSS-Bridge/rss-bridge
```
Then add a `docker-compose.yml` file:
```yml
version: '3'
services:
rss-bridge:
build:
context: ./rss-bridge
ports:
- 3000:80
volumes:
- ./config:/config
- ./rss-bridge/bridges:/app/bridges
```
You can then access RSS-Bridge at `localhost:3000` and [add your bridge](../05_Bridge_API/How_to_create_a_new_bridge) to the `rss-bridge/bridges` folder.
If you need to edit any other files, like from the `lib` folder add this to the `volumes` section: `./rss-bridge/lib:/app/lib`.
### Docs with Docker
## Docs with Docker
If you want to edit the docs add this to your docker-compose.yml: