From a2d2bc4a284d22d63a76bbc68b5735de4f6e5fbd Mon Sep 17 00:00:00 2001 From: prilka Date: Mon, 5 Aug 2019 21:25:38 +0200 Subject: [PATCH] update README.md new environment variables documented and example updated --- README.md | 33 ++++++++++++++------------------- 1 file changed, 14 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 9768276..f01e907 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ # Running the container + 0. Become root if your user is not part of the docker group: ``` @@ -19,31 +20,25 @@ ``` docker run -d --name jd2 \ + -e EMAIL=my@mail.com -e PASSWORD=my_secret_password -v /config/jd2:/opt/JDownloader/cfg \ -v /home/user/Downloads:/opt/JDownloader/Downloads \ plusminus/jdownloader2-headless ``` -3. Wait a minute for the container to initialize -4. Stop the container: - ``` - docker stop jd2 - ``` -5. On your host, enter your credentials (in quotes) to the file `org.jdownloader.api.myjdownloader.MyJDownloaderSettings.json` as in: +If you don't want to specify your credentials on the command line, remove them from the command above (`-e EMAIL=... -e PASSWORD=...`) +and add them manually to the file`/org.jdownloader.api.myjdownloader.MyJDownloaderSettings.json` as in - ``` - { "email" : "email@home.org", "password" : "mypasswort" } - ``` -6. Start the container: - - ``` - docker start jd2 - ``` +``` +{ "email" : "my@mail.com", "password" : "my_secret_password" } +``` # Optional environment variables -|Environment Variable|Description| -|--------------------|-----------| -|UID|Specifies the UID the daemon should run as. All created files will be owned by this UID. Defaults to 1000.| -|GID|Specifies the GID for all created files. This only works in combination with the UID. Defaults to 100 for users.| +Environment Variable | Description +---------------------|------------ +EMAIL | The MyJDownloader account e-mail. Is written automatically to config-file, if set. +PASSWORD | The MyJDownloader account password. Is written automatically to config-file, if set. +UID | Specifies the UID the daemon should run as. All created files will be owned by this UID. Defaults to 1000. +GID | Specifies the GID for all created files. This only works in combination with the UID. Defaults to 100 for users. -Not setting these will default to 1000:100. +Not setting `UID` / `GID` will default to `1000`:`100`.