docs: simplify docker compose path guide

This commit is contained in:
ShukeBta
2026-06-09 19:29:26 +08:00
parent bfb0243712
commit eda5d9a978
3 changed files with 136 additions and 39 deletions
+61 -18
View File
@@ -194,7 +194,7 @@ MediaStationGo 采用完全开源路线,核心媒体库、刮削、播放、
### Docker Compose 部署(推荐)
默认部署现在改成了**新手极简模式**:只需要准备一个 `docker-compose.yml`,再在 `.env` 里填写两个目录。
默认部署主线改为**直接编辑 `docker-compose.yml`**:把 NAS/服务器真实目录写进 compose 文件里,路径最直观,也最适合刚接触 NAS、VPS 或 Docker 的用户。
#### 1. 创建部署目录
@@ -212,27 +212,42 @@ curl -fsSL https://raw.githubusercontent.com/ShukeBta/MediaStationGo/main/docker
如果 GitHub Raw 访问慢,可以手动创建 `docker-compose.yml`,内容以仓库根目录的 `docker-compose.yml` 为准。
#### 3. 创建 `.env`
#### 3. 编辑真实路径
只需要改下面两个路径:
打开 compose:
```bash
cat > .env <<'EOF'
MEDIASTATION_MEDIA_DIR=/your-nas/media
MEDIASTATION_DOWNLOAD_DIR=/your-nas/downloads
MEDIASTATION_HTTP_PORT=18080
TZ=Asia/Shanghai
PUID=1000
PGID=1000
EOF
vi docker-compose.yml
```
路径怎么填:
先找到 `volumes` 里的媒体库和下载目录,把左边改成你的 NAS/服务器真实路径,例如:
| 变量 | 填什么 |
```yaml
volumes:
- ./data:/data
- ./cache:/cache
- /vol1/1000/Docker/moviepilot-v2/media:/media:ro
- /vol1/1000/qBittorrent/downloads:/downloads
```
再找到 `environment` 里的路径提示,把同样的真实路径写进去:
```yaml
environment:
MEDIASTATION_MEDIA_DIR: /vol1/1000/Docker/moviepilot-v2/media
MEDIASTATION_MEDIA_CONTAINER_DIR: /media
MEDIASTATION_DOWNLOAD_DIR: /vol1/1000/qBittorrent/downloads
MEDIASTATION_DOWNLOAD_CONTAINER_DIR: /downloads
```
路径怎么理解:
| 位置 | 填什么 |
| --- | --- |
| `MEDIASTATION_MEDIA_DIR` | NAS/服务器上的真实媒体目录,例如 `/volume1/media`、`/mnt/media`、`/vol1/1000/Docker/moviepilot-v2/media` |
| `MEDIASTATION_DOWNLOAD_DIR` | NAS/服务器上的真实下载目录,例如 `/volume1/downloads`、`/mnt/downloads`、`/vol1/1000/qBittorrent/downloads` |
| `volumes` 左侧媒体路径 | NAS/服务器上的真实媒体目录,例如 `/volume1/media`、`/mnt/media`、`/vol1/1000/Docker/moviepilot-v2/media` |
| `volumes` 左侧下载路径 | NAS/服务器上的真实下载目录,例如 `/volume1/downloads`、`/mnt/downloads`、`/vol1/1000/qBittorrent/downloads` |
| `MEDIASTATION_MEDIA_DIR` | 和媒体库 `volumes` 左侧保持一致 |
| `MEDIASTATION_DOWNLOAD_DIR` | 和下载目录 `volumes` 左侧保持一致 |
> 不要写成 `./vol1/...`。带 `./` 是相对路径,会变成当前部署目录下面的文件夹。
@@ -294,15 +309,43 @@ docker compose logs -f mediastation-go
#### 高级配置
默认文件只保留新手必需项。需要直读宿主机原始路径、Telegram 代理、硬件加速、更多转码环境变量时,参考仓库中的高级示例:
默认文件只保留新手必需项。需要让容器内也显示宿主机原始路径、Telegram 代理、硬件加速、更多转码环境变量时,参考仓库中的高级示例:
```text
docker-compose.advanced.yml
```
### 可选:使用 `.env` 管理路径
如果你已经熟悉 Docker Compose,或者同一份 compose 要在多台机器复用,也可以把路径写进 `.env`。这是可选玩法,不是新手主线:
```bash
cat > .env <<'EOF'
MEDIASTATION_MEDIA_DIR=/vol1/1000/Docker/moviepilot-v2/media
MEDIASTATION_DOWNLOAD_DIR=/vol1/1000/qBittorrent/downloads
MEDIASTATION_HTTP_PORT=18080
TZ=Asia/Shanghai
PUID=1000
PGID=1000
EOF
```
使用 `.env` 时,`docker-compose.yml` 中保持默认变量写法即可:
```yaml
- ${MEDIASTATION_MEDIA_DIR:-./media}:/media:ro
- ${MEDIASTATION_DOWNLOAD_DIR:-./downloads}:/downloads
```
### 固定版本部署
生产环境可以固定镜像版本,避免 `latest` 自动变化。只需要在 `.env` 里增加:
生产环境可以固定镜像版本,避免 `latest` 自动变化。不使用 `.env` 时,直接把 compose 里的镜像改成固定版本:
```yaml
image: ghcr.io/shukebta/mediastation-go:MediaStationGo-v0.0.32
```
如果使用 `.env`,也可以写:
```env
MEDIASTATION_IMAGE_TAG=MediaStationGo-v0.0.32
@@ -341,7 +384,7 @@ http://host.docker.internal:8085
## 🐳 Docker Compose 配置示例
项目默认内置极简 `docker-compose.yml`,新手通常只需要下面几个变量:
项目默认内置极简 `docker-compose.yml`。新手推荐直接在 `volumes` 左侧写真实路径,并让 `MEDIASTATION_MEDIA_DIR`、`MEDIASTATION_DOWNLOAD_DIR` 与左侧路径保持一致;`.env` 变量适合进阶用户复用配置:
| 变量 | 默认值 | 说明 |
| --- | --- | --- |