Skip to content
This repository has been archived by the owner on Jul 9, 2020. It is now read-only.

Commit

Permalink
Update env-var-info.md
Browse files Browse the repository at this point in the history
Updated some wording for consistency. Expanded on `MEDIADIR` as discussed on #44
  • Loading branch information
angrycuban13 authored Jun 28, 2020
1 parent f752354 commit aa92ce6
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions docs/basics/env-var-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This can be increased if you are seeing timeout issues when running compose. It
* Default value: `~/.config/appdata`

Description:
This is the directory where all your docker configuration is saved to.
This is the directory where all your containers' configuration is saved to.

## DOCKERGID

Expand All @@ -37,77 +37,78 @@ All containers will default to having this hostname.
* Default value: `10`

Description:
The maximum number of log files that can be present. If rolling the logs creates excess files, the oldest file is removed.

## DOCKERLOGGING_MAXSIZE

* Default value: `200k`

Description:
Maximum size in kilobytes that the log file will be before it is rotated.
The maximum size of the log before it is rotated. Size is specified in kilobytes.

## DOCKERSHAREDDIR

* System Detected value: `~/.config/appdata/shared`
* Default value: `~/.config/appdata/shared`

Description:
This is the default shared folder between all containers. You can place anything here and it can be accessed from any other container, such as scripts.
This directory will be mounted under `/shared` inside every container across DS. There is no specific use for this directory, it can be used however you like.

## DOWNLOADSDIR

* System Detected value: `~/Downloads`
* Default value: `/mnt/downloads`

Description:
This is the default folder where all your downloads are located. To be used with SABnzbd, NZBGet, and any torrent clients.
This directory will be mounted under `/downloads` inside any container that is used for downloading. Do **not** use this directory as permanent storage for your media. See below for `MEDIADIR` directories.

## MEDIADIR_AUDIOBOOKS

* System Detected value: `~/Audioooks`
* Default value: `/mnt/medialibrary/audiobooks`

Description:
This is the default folder where all audiobooks are stored.
This directory will be mounted under `/audiobooks` inside any container that is used to access your audiobooks library. This directory is meant to store media permanently.

## MEDIADIR_BOOKS

* System Detected value: `~/Books`
* Default value: `/mnt/medialibrary/books`

Description:
This is the default folder where all books are stored.
This directory will be mounted under `/books` inside any container that is used to access your books library. This directory is meant to store media permanently.

## MEDIADIR_COMICS

* System Detected value: `~/Comics`
* Default value: `/mnt/medialibrary/comics`

Description:
This is the default folder where all comics are stored.
This directory will be mounted under `/comics` inside any container that is used to access your comics library. This directory is meant to store media permanently.

## MEDIADIR_MOVIES

* System Detected value: `~/Movies`
* Default value: `/mnt/medialibrary/movies`

Description:
This is the default folder where all movies are stored. To be used with Radarr, Bazarr, etc.
This directory will be mounted under `/movies` inside any container that is used to access your movie library. This directory is meant to store media permanently.

## MEDIADIR_MUSIC

* System Detected value: `~/Music`
* Default value: `/mnt/medialibrary/music`

Description:
This is the default folder where all movies are stored. To be used with Lidarr.
This directory will be mounted under `/music` inside any container that is used to access your music library. This directory is meant to store media permanently.

## MEDIADIR_TV

* System Detected value: `~/TV`
* Default value: `/mnt/medialibrary/tv`

Description:
This is the default folder where all movies are stored. To be used with Sonarr, Bazarr, etc.
This directory will be mounted under `/tv` inside any container that is used to access your TV library. This directory is meant to store media permanently.

## PGID

Expand Down Expand Up @@ -138,7 +139,7 @@ Description:
* Default value: `192.168.x.x/24`

Description:
Only accepts values in these ranges 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16. If this value is blank or contains `x` DockSTARTer will automatically replace it with the System Detected value.
If this value is blank or contains `x` DockSTARTer will automatically replace it with the System Detected value. Only accepts values in these ranges 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16.

## NS1

Expand All @@ -157,6 +158,7 @@ Description:
* Default value: `yes`

Description:
Only accepts `yes` or `no`. It specifies whether the VPN is enabled or not to be used by VPN enabled containers.

## VPN_OPTIONS

Expand All @@ -169,7 +171,7 @@ Description:
* Default value: `~/.config/appdata/.openvpn`

Description:
Directory where you will save your `ovpn` configuration so any VPN enabled containers use this VPN configuration.
This directory will be used to store `ovpn` configurations that will be used by containers that are VPN enabled.

## VPN_PASS

Expand Down

0 comments on commit aa92ce6

Please sign in to comment.