mirror of
https://github.com/alexta69/metube.git
synced 2025-04-03 20:27:36 +03:00
update readme to add new mode description
This commit is contained in:
parent
efb0001708
commit
ccd1d5a891
1 changed files with 34 additions and 0 deletions
34
README.md
34
README.md
|
@ -9,12 +9,45 @@ Web GUI for youtube-dl (using the [yt-dlp](https://github.com/yt-dlp/yt-dlp) for
|
|||
|
||||
## Run using Docker
|
||||
|
||||
### New Mode(recommend)
|
||||
|
||||
```bash
|
||||
docker run -d -p 8081:8081 -v /path/to/downloads:/downloads -e UID=1001 -e GID=1001 -e UMASK=000 alexta69/metube
|
||||
```
|
||||
|
||||
***Warning, if you also set the `--user` parameter, the `UID` and `GID` environment variable will be invalid. And it will run in legacy mode.***
|
||||
|
||||
### Legacy Mode(not recommend)
|
||||
|
||||
```bash
|
||||
docker run -d -p 8081:8081 -v /path/to/downloads:/downloads --user 1001:1001 alexta69/metube
|
||||
```
|
||||
|
||||
## Run using docker-compose
|
||||
|
||||
### New Mode(recommend)
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
services:
|
||||
metube:
|
||||
image: alexta69/metube
|
||||
container_name: metube
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
- UID=1001
|
||||
- GID=1001
|
||||
- UMASK=000
|
||||
ports:
|
||||
- "8081:8081"
|
||||
volumes:
|
||||
- /path/to/downloads:/downloads
|
||||
```
|
||||
|
||||
***Warning, if you also set the `--user` parameter, the `UID` and `GID` environment variable will be invalid. And it will run in legacy mode.***
|
||||
|
||||
### Legacy Mode(not recommend)
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
services:
|
||||
|
@ -28,6 +61,7 @@ services:
|
|||
volumes:
|
||||
- /path/to/downloads:/downloads
|
||||
```
|
||||
|
||||
## Configuration via environment variables
|
||||
|
||||
Certain values can be set via environment variables, using the `-e` parameter on the docker command line, or the `environment:` section in docker-compose.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue