jdownloader2-headless/README.md
prilka a2d2bc4a28 update README.md
new environment variables documented and example updated
2019-08-05 21:26:17 +02:00

44 lines
2.3 KiB
Markdown

[![Build Status](https://travis-ci.com/PlusMinus0/headless-jd2-docker.svg?branch=master)](https://travis-ci.com/PlusMinus0/headless-jd2-docker)
# Supported tags
* [`latest`, `debian`, `v3.0-debian` (debian.Dockerfile)](https://github.com/PlusMinus0/headless-jd2-docker/blob/master/debian.Dockerfile)
* [`alpine`, `v3.0-alpine` (alpine.Dockerfile)](https://github.com/PlusMinus0/headless-jd2-docker/blob/master/alpine.Dockerfile)
* [`dev-debian` (debian.Dockerfile)](https://github.com/PlusMinus0/headless-jd2-docker/blob/dev/debian.Dockerfile)
* [`dev-alpine` (alpine.Dockerfile)](https://github.com/PlusMinus0/headless-jd2-docker/blob/dev/alpine.Dockerfile)
* [`v2.1` (Dockerfile)](https://github.com/PlusMinus0/headless-jd2-docker/blob/v2.1/Dockerfile)
* [`v2.0` (Dockerfile)](https://github.com/PlusMinus0/headless-jd2-docker/blob/v2.0/Dockerfile)
# Running the container
0. Become root if your user is not part of the docker group:
```
sudo su
```
1. Create a folder on your host for the configuration files (eg. sudo mkdir /config/jd2)
2. Run the container:
```
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
```
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`<config-dir>/org.jdownloader.api.myjdownloader.MyJDownloaderSettings.json` as in
```
{ "email" : "my@mail.com", "password" : "my_secret_password" }
```
# Optional environment variables
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 `UID` / `GID` will default to `1000`:`100`.