diff options
author | 2024-08-01 23:36:14 +0200 | |
---|---|---|
committer | 2024-08-01 23:36:14 +0200 | |
commit | 0051e0fcddfe008b34e990dce6e7e3c61bae3eea (patch) | |
tree | 0741abaf45cf2f36c6077d6c967b2253b229050b /docs/04_For_Developers | |
parent | d050fe9a9b6476efde29891eb59e87505e3200bf (diff) | |
download | rss-bridge-0051e0fcddfe008b34e990dce6e7e3c61bae3eea.tar.gz rss-bridge-0051e0fcddfe008b34e990dce6e7e3c61bae3eea.tar.zst rss-bridge-0051e0fcddfe008b34e990dce6e7e3c61bae3eea.zip |
docs: improve docker docs (#4183)
* docs: improve docker docs
* fix: cleanup and remove duplicate docker instructions
Diffstat (limited to 'docs/04_For_Developers')
-rw-r--r-- | docs/04_For_Developers/07_Development_Environment_Setup.md | 36 |
1 files changed, 1 insertions, 35 deletions
diff --git a/docs/04_For_Developers/07_Development_Environment_Setup.md b/docs/04_For_Developers/07_Development_Environment_Setup.md index 23a4b101..d3a5ee8d 100644 --- a/docs/04_For_Developers/07_Development_Environment_Setup.md +++ b/docs/04_For_Developers/07_Development_Environment_Setup.md @@ -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: |