Skip to content

Commit c9d5c36

Browse files
committed
chore: Update the quick start/install pages
1 parent 65c723e commit c9d5c36

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

docs/deployment/docker-compose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ M3U Editor offers multiple Docker Compose configurations to fit different use ca
1616

1717
| Use Case | File | Description |
1818
|----------|------|-------------|
19-
| **⭐ Recommended** | `docker-compose.proxy.yml` | Modular setup with separate containers for m3u-editor, m3u-proxy, and Redis |
19+
| ** Recommended** | `docker-compose.proxy.yml` | Modular setup with separate containers for m3u-editor, m3u-proxy, and Redis |
2020
| **Simple** | `docker-compose.aio.yml` | All-in-one container for quick testing |
2121
| **VPN** | `docker-compose.proxy-vpn.yml` | Modular deployment with Gluetun VPN |
2222
| **Advanced** | `docker-compose.external-all.yml` | Fully modular with external Nginx |

docs/installation.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,17 @@ Before you begin, ensure you have:
2828

2929
M3U Editor offers several deployment options to fit your needs:
3030

31-
### ⭐ Recommended: Modular Deployment
31+
#### 🐳 Docker compose file reference
32+
33+
| Use Case | File | Description |
34+
| --------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
35+
| **Modular Deployment** | [docker-compose.proxy.yml](./installation#-recommended-modular-deployment) | ⭐⭐ Recommended! Separate containers for **m3u-editor**, **m3u-proxy** (_the external proxy setup is required for hardware acceleration_), and **Redis** — perfect if you want more granular control (_Postgres and NGINX can be easily added as a seperate container as well_). |
36+
| **All-in-One Deployment** | [docker-compose.aio.yml](./installation#simple-all-in-one-deployment) | A simple, all-in-one solution — everything runs in a single container for quick setup (_hardware acceleration is not supported in this setup_). |
37+
| **Modular + VPN** | [docker-compose.proxy-vpn](./installation#advanced-modular-with-vpn) | Example of modular deployment using Gluetun VPN. |
38+
39+
<small>For more examples, see the [Deployments](./deployment/docker-compose.md) page</small>
40+
41+
### ⭐⭐ Recommended: Modular Deployment
3242

3343
**File**: `docker-compose.proxy.yml`
3444

@@ -102,6 +112,6 @@ Once your containers are running:
102112

103113
## Need Help?
104114

105-
- Join our [Discord](https://discord.gg/rS3abJ5dz7)
106-
- 🐛 [Report an issue](https://github.com/sparkison/m3u-editor/issues/new?template=bug_report.md)
107-
- 📖 [GitHub Discussions](https://github.com/sparkison/m3u-editor/discussions)
115+
- Join our [Discord](https://discord.gg/rS3abJ5dz7)
116+
- [Report an issue](https://github.com/sparkison/m3u-editor/issues/new?template=bug_report.md)
117+
- [GitHub Discussions](https://github.com/sparkison/m3u-editor/discussions)

0 commit comments

Comments
 (0)