Skip to content

Commit 2d7a98c

Browse files
I-am-PUID-0I-am-PUID-0
committed
docs(readme): refine project list and update usage notes
1 parent e67185e commit 2d7a98c

File tree

1 file changed

+20
-90
lines changed

1 file changed

+20
-90
lines changed

‎README.md‎

Lines changed: 20 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -53,31 +53,25 @@
5353

5454
**Debrid Unlimited Media Bridge (DUMB)** is an All-In-One (AIO) docker image for the unified deployment of the following projects/tools.
5555

56-
> [!Note]
57-
> You are free to use and control which ever components you wish to use.
58-
> Not all a required and serveral do the same thing - albiet in a different way
59-
60-
| Project | Author |
61-
| ------------------------------------------------------------------- | ------------------------------------------------------------------------ |
62-
| [cli_debrid](https://github.com/godver3/cli_debrid) | [godver3](https://github.com/godver3) |
63-
| [Decypharr](https://github.com/sirrobot01/decypharr) | [Mukhtar Akere](https://github.com/sirrobot01) |
64-
| [Plex Media Server - Docker](https://github.com/plexinc/pms-docker) | [plexinc](https://github.com/plexinc) |
65-
| [plex_debrid](https://github.com/itsToggle/plex_debrid) | [itsToggle](https://github.com/itsToggle) |
66-
| [PostgreSQL](https://www.postgresql.org/) | [Michael Stonebraker](https://en.wikipedia.org/wiki/Michael_Stonebraker) |
67-
| [rclone](https://github.com/rclone/rclone) | [Nick Craig-Wood](https://github.com/ncw) |
68-
| [Riven](https://github.com/rivenmedia/riven) | [Riven Media](https://github.com/rivenmedia) |
69-
| [Zurg](https://github.com/debridmediamanager/zurg-testing) | [yowmamasita](https://github.com/yowmamasita) |
70-
| [Zilean](https://github.com/iPromKnight/zilean) | [iPromKnight](https://github.com/iPromKnight) |
71-
| | |
72-
73-
74-
> [!CAUTION]
75-
> Docker Desktop **CANNOT** be used to run DUMB!
76-
> Docker Desktop does not support the [mount propagation](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) required for rclone mounts.
77-
>
78-
> ![image](https://github.com/I-am-PUID-0/DUMB/assets/36779668/aff06342-1099-4554-a5a4-72a7c82cb16e)
79-
>
80-
> See the DUMB Docs for [alternative deployment options](https://i-am-puid-0.github.io/DUMB/deployment/wsl) to run DUMB on Windows through `WSL2`.
56+
57+
## 📦 Projects Included
58+
59+
> You are free to use whichever components you like. Not all are required, and some may provide overlapping functionality in different ways.
60+
61+
| Project | Author | Community / Docs / Support | 🍻 Support Dev |
62+
|--------------------------------------------------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
63+
| [cli_debrid](https://github.com/godver3/cli_debrid) | [godver3](https://github.com/godver3) | [Discord](https://discord.gg/jAmqZJCZJ4) | [Sponsor](https://github.com/sponsors/godver3) |
64+
| [phalanx_db](https://github.com/godver3/phalanx_db_hyperswarm) | [godver3](https://github.com/godver3) | [Discord](https://discord.gg/jAmqZJCZJ4) | [Sponsor](https://github.com/sponsors/godver3) |
65+
| [Decypharr](https://github.com/sirrobot01/decypharr) | [Mukhtar Akere](https://github.com/sirrobot01) | [Docs](https://sirrobot01.github.io/decypharr/) • [Issues](https://github.com/sirrobot01/decypharr/issues) | [Sponsor](https://github.com/sponsors/sirrobot01) |
66+
| [plex_debrid](https://github.com/itsToggle/plex_debrid) | [itsToggle](https://github.com/itsToggle) | [Discord](https://discord.gg/u3vTDGjeKE) • [Issues](https://github.com/itsToggle/plex_debrid/issues) | [Affiliate](http://real-debrid.com/?id=5708990) • [PayPal](https://www.paypal.com/paypalme/oidulibbe) |
67+
| [Riven](https://github.com/rivenmedia/riven) | [Riven Media](https://github.com/rivenmedia) | [Discord](https://discord.gg/VtYd42mxgb) • [Discussions](https://github.com/orgs/rivenmedia/discussions) | [Sponsor](https://github.com/sponsors/dreulavelle/) |
68+
| [Zilean](https://github.com/iPromKnight/zilean) | [iPromKnight](https://github.com/iPromKnight) | — | — |
69+
| [Zurg](https://github.com/debridmediamanager/zurg-testing) | [yowmamasita](https://github.com/yowmamasita) | — | [Sponsor](https://github.com/sponsors/debridmediamanager) |
70+
| [rclone](https://github.com/rclone/rclone) | [Nick Craig-Wood](https://github.com/ncw) | [Docs](https://rclone.org/) | [Sponsor](https://rclone.org/sponsor/) |
71+
| [PostgreSQL](https://www.postgresql.org/) | [Michael Stonebraker](https://en.wikipedia.org/wiki/Michael_Stonebraker) | [Docs](https://www.postgresql.org/docs/) | [Donate](https://www.postgresql.org/about/donate/) |
72+
| [Plex Media Server](https://www.plex.tv/media-server-downloads/) | [plexinc](https://www.plex.tv/) | [Support](https://support.plex.tv/) | [Donate](https://www.plex.tv/plex-pass/) (via Plex Pass) |
73+
74+
8175

8276
## 🌟 Features
8377

@@ -93,9 +87,6 @@ A prebuilt image is hosted on [GitHub Container Registry](https://github.com/I-a
9387

9488
## 🐳 Docker-compose
9589

96-
> [!NOTE]
97-
> The below examples are not exhaustive and are intended to provide a starting point for deployment.
98-
9990
```YAML
10091
services:
10192
DUMB:
@@ -195,23 +186,12 @@ format: `<HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]`.
195186
| `/phalanx_db/data` | rw | This is where phalanx_db will store its data. |
196187
| `/decypharr` | rw | This is where decypharr will store its data. |
197188
| `/plex` | rw | This is where Plex Media Server will store its data. |
189+
| `/mnt/debrid` | rw | This is where the symlinks and rclone mounts will be stored |
198190

199191
## 📝 TODO
200192

201193
See the [DUMB roadmap](https://github.com/users/I-am-PUID-0/projects/7) for a list of planned features and enhancements.
202194

203-
## 🛠️ DEV
204-
205-
### Tracking current development for an upcoming release:
206-
207-
- [Pre-Release Changes](https://gist.github.com/I-am-PUID-0/7e02c2cb4a5211d810a913f947861bc2#file-pre-release_changes-md)
208-
- [Pre-Release TODO](https://gist.github.com/I-am-PUID-0/7e02c2cb4a5211d810a913f947861bc2#file-pre-release_todo-md)
209-
210-
### Development support:
211-
212-
- The repo contains a devcontainer for use with vscode.
213-
- Bind mounts will need to be populated with content from this repo
214-
215195
## 🚀 Deployment
216196

217197
DUMB allows for the simultaneous or individual deployment of any of the services
@@ -220,60 +200,10 @@ For additional details on deployment, see the [DUMB Docs](https://i-am-puid-0.gi
220200

221201
## 🌍 Community
222202

223-
### DUMB
224-
225203
- For questions related to DUMB, see the GitHub [discussions](https://github.com/I-am-PUID-0/DUMB/discussions)
226204
- or create a new [issue](https://github.com/I-am-PUID-0/DUMB/issues) if you find a bug or have an idea for an improvement.
227205
- or join the DUMB [discord server](https://discord.gg/T6uZGy5XYb)
228206

229-
### Riven Media
230-
231-
- For questions related to Riven, see the GitHub [discussions](https://github.com/orgs/rivenmedia/discussions)
232-
- or create a new [issue](https://github.com/rivenmedia/riven/issues) if you find a bug or have an idea for an improvement.
233-
- or join the Riven [discord server](https://discord.gg/VtYd42mxgb)
234-
235-
### plex_debrid
236-
- For questions related to plex_debrid, see the GitHub [discussions](https://github.com/itsToggle/plex_debrid/discussions)
237-
- or create a new [issue](https://github.com/itsToggle/plex_debrid/issues) if you find a bug or have an idea for an improvement.
238-
- or join the plex_debrid [discord server](https://discord.gg/u3vTDGjeKE)
239-
240-
### cli_debrid & phalanx_db
241-
- For questions related to cli_debrid or phalanx_db, join the cli_debrid [discord server](https://discord.gg/jAmqZJCZJ4)
242-
- or create a new [issue](https://github.com/godver3/cli_debrid/issues) if you find a bug or have an idea for an improvement.
243-
244-
### Decypharr
245-
- For questions related to decypharr, check out the [Docs](https://sirrobot01.github.io/decypharr/)
246-
- or create a new [issue](https://github.com/sirrobot01/decypharr/issues) if you find a bug or have an idea for an improvement.
247-
248-
249-
## 🍻 Buy **[Riven Media](https://github.com/rivenmedia)** a beer/coffee? :)
250-
251-
If you enjoy the underlying projects and want to buy Riven Media a beer/coffee, feel free to use the [GitHub sponsor link](https://github.com/sponsors/dreulavelle/)
252-
253-
## 🍻 Buy **[itsToggle](https://github.com/itsToggle)** a beer/coffee? :)
254-
255-
If you enjoy the underlying projects and want to buy itsToggle a beer/coffee, feel free to use the real-debrid [affiliate link](http://real-debrid.com/?id=5708990) or send a virtual beverage via [PayPal](https://www.paypal.com/paypalme/oidulibbe) :)
256-
257-
## 🍻 Buy **[godver3](https://github.com/godver3)** a beer/coffee? :)
258-
259-
If you enjoy the underlying projects and want to buy godver3 a beer/coffee, feel free to use the [GitHub sponsor link](https://github.com/sponsors/godver3)
260-
261-
## 🍻 Buy **[Mukhtar Akere](https://github.com/sirrobot01)** a beer/coffee? :)
262-
263-
If you enjoy the underlying projects and want to buy Mukhtar Akere a beer/coffee, feel free to use the [GitHub sponsor link](https://github.com/sponsors/sirrobot01)
264-
265-
## 🍻 Buy **[yowmamasita](https://github.com/yowmamasita)** a beer/coffee? :)
266-
267-
If you enjoy the underlying projects and want to buy yowmamasita a beer/coffee, feel free to use the [GitHub sponsor link](https://github.com/sponsors/debridmediamanager)
268-
269-
## 🍻 Buy **[Nick Craig-Wood](https://github.com/ncw)** a beer/coffee? :)
270-
271-
If you enjoy the underlying projects and want to buy Nick Craig-Wood a beer/coffee, feel free to use the website's [sponsor links](https://rclone.org/sponsor/)
272-
273-
## 🍻 Buy **[PostgreSQL](https://www.postgresql.org)** a beer/coffee? :)
274-
275-
If you enjoy the underlying projects and want to buy PostgreSQL a beer/coffee, feel free to use the [sponsor link](https://www.postgresql.org/about/donate/)
276-
277207
## ✅ GitHub Workflow Status
278208

279209
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/I-am-PUID-0/DUMB/docker-image.yml)

0 commit comments

Comments
 (0)