From 7858e26b152f8f3f63e223afd89cf31c8e4ad404 Mon Sep 17 00:00:00 2001 From: Tzahi12345 Date: Sat, 1 Aug 2020 14:06:47 -0400 Subject: [PATCH] Update README.md Updated Docker section in README to show how to use a custom UID/GID --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 09db002..2249166 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,8 @@ Alternatively, you can port forward the port specified in the config (defaults t ## Docker +### Setup + If you are looking to setup YoutubeDL-Material with Docker, this section is for you. And you're in luck! Docker setup is quite simple. 1. Run `curl -L https://github.com/Tzahi12345/YoutubeDL-Material/releases/latest/download/docker-compose.yml -o docker-compose.yml` to download the latest Docker Compose, or go to the [releases](https://github.com/Tzahi12345/YoutubeDL-Material/releases/) page to grab the version you'd like. @@ -76,6 +78,16 @@ If you are looking to setup YoutubeDL-Material with Docker, this section is for 3. Run `docker-compose up` to start it up. If successful, it should say "HTTP(S): Started on port 8998" or something similar. 4. Make sure you can connect to the specified URL + port, and if so, you are done! +### Custom UID/GID + +By default, the Docker container runs as non-root with UID=1000 and GID=1000. To set this to your own UID/GID, simply update the `environment` section in your `docker-compose.yml` like so: + +``` +environment: + UID: YOUR_UID + GID: YOUR_GID +``` + ## API [API Docs](https://stoplight.io/p/docs/gh/tzahi12345/youtubedl-material?group=master&utm_campaign=publish_dialog&utm_source=studio)