Variable info

[nemchik]

We need a new page under the basic section that explains how each variable in https://github.com/GhostWriters/DockSTARTer/blob/master/compose/.env.example works.

It may also contain common variable types that you would see for each app like _PORT_ and DIR and backups, etc.

Each variable should have its explanation as well as mention of it's default or system detected value (and how default and system detected values work).

COMPOSE_HTTP_TIMEOUT=60
DOCKERCONFDIR=~/.config/appdata
DOCKERGID=999
DOCKERHOSTNAME=DockSTARTer
DOCKERLOGGING_MAXFILE=10
DOCKERLOGGING_MAXSIZE=200k
DOCKERSHAREDDIR=~/.config/appdata/shared
DOWNLOADSDIR=/mnt/downloads
MEDIADIR_AUDIOBOOKS=/mnt/medialibrary/audiobooks
MEDIADIR_BOOKS=/mnt/medialibrary/books
MEDIADIR_COMICS=/mnt/medialibrary/comics
MEDIADIR_MOVIES=/mnt/medialibrary/movies
MEDIADIR_MUSIC=/mnt/medialibrary/music
MEDIADIR_TV=/mnt/medialibrary/tv
PGID=1000
PUID=1000
TZ=America/Chicago

LAN_NETWORK=192.168.x.x/24
NS1=1.1.1.1
NS2=8.8.8.8
VPN_ENABLE=yes
VPN_OPTIONS=
VPN_OVPNDIR=~/.config/appdata/.openvpn
VPN_PASS=
VPN_PROV=custom
VPN_USER=

[angrycuban13]

Commenting so I can start working on this in the next few days.

[nemchik]

Ok, I've cleaned up the comments here. I've also added all the variables and their default values to the op. I'll start adding explanations to the op this week. We'll need a decent looking format for all this in markdown. I'm thinking each variable will be a heading so that it makes links on the website.

[angrycuban13]

Okay so are we thinking of something like this:

COMPOSE_HTTP_TIMEOUT

• Configures the time (in seconds) a request to the Docker daemon is allowed to hang before Compose considers it failed. Defaults to 60 seconds.
• Accepts integers only.

[angrycuban13]

Can you develop a bit more of what should be default or system detected

[nemchik]

Default values are whatever is shown in https://github.com/GhostWriters/DockSTARTer/blob/master/compose/.env.example (posted above).

System detected values are shown for certain variables where DS tries to figure out the correct value that should be used by reading values from your system. Here is the code for this https://github.com/GhostWriters/DockSTARTer/blob/929e59861e7dc14550bf88980b3f44612fa91efc/.scripts/menu_value_prompt.sh#L28-L88 There's Use system and Use home. I'll follow this up with another comment and try to summarize them all in actual words.

[nemchik]

## COMPOSE_HTTP_TIMEOUT
* Default value: `60`
Description:
See https://docs.docker.com/compose/reference/envvars/#compose_http_timeout
This can be increased if you are seeing timeout issues when running compose. It is uncommon to need to adjust this option, but has been seen most commonly on very low powered CPU systems (older raspberry pi) or systems with failing storage (hard drives).

## DOCKERCONFDIR
* System Detected value: `~/.config/appdata`
* Default value: `~/.config/appdata`
Description:

## DOCKERGID
* System Detected value: The owner of the `docker` group on your system
* Default value: `999` because it is the default ID given to the `docker` group when it is created by [https://get.docker.com](https://get.docker.com)
Description:

## DOCKERHOSTNAME
* System Detected value:
* Default value: `DockSTARTer` because we don't want it to be accidentally blank
Description:

## DOCKERLOGGING_MAXFILE
* Default value: `10`
Description:

## DOCKERLOGGING_MAXSIZE
* Default value: `200k`
Description:

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

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

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

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

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

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

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

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

## PGID
* System Detected value: Detects the ID of your group
* Default value: `1000` because this is the most common default on supported OS
Description:

## PUID
* System Detected value: Detects the ID of your user
* Default value: `1000` because this is the most common default on supported OS
Description:

## TZ
* System Detected value: Uses the value found in `/etc/timezone`
* Default value: `America/Chicago` because that's @nemchik's timezone (CST)

## LAN_NETWORK
* System Detected value:
* Default value: `192.168.x.x/24`
Description:

## NS1
* Default value: `1.1.1.1`
Description:

## NS2
* Default value: `8.8.8.8`
Description:

## VPN_ENABLE
* Default value: `yes`
Description:

## VPN_OPTIONS
* Default value:
Description:

## VPN_OVPNDIR
* Default value: `~/.config/appdata/.openvpn`
Description:

## VPN_PASS
* Default value:
Description:

## VPN_PROV
* Default value: `custom`
Description:

## VPN_USER
* Default value:
Description:

[angrycuban13]

Okay since you did most of the footwork, I'll just fill in the Description field and you can review it.

What section are you thinking of adding this to?

[nemchik]

I'd like this to be a new page under the basic category.

[angrycuban13]

Okay I’ll get started on this. I’ve had enough of PMA and MDB lol.

[angrycuban13]

DockSTARTer Variable Information

## COMPOSE_HTTP_TIMEOUT
* Default value: `60`
Description:
See https://docs.docker.com/compose/reference/envvars/#compose_http_timeout
This can be increased if you are seeing timeout issues when running compose. It is uncommon to need to adjust this option, but has been seen most commonly on very low powered CPU systems (older raspberry pi) or systems with failing storage (hard drives).

## DOCKERCONFDIR
* System Detected value: `~/.config/appdata`
* Default value: `~/.config/appdata`
Description: This is the directory where all your docker configuration is saved to.

## DOCKERGID
* System Detected value: The owner of the `docker` group on your system
* Default value: `999`
Description: Default ID given to the `docker` group when it is created by [https://get.docker.com](https://get.docker.com)

## DOCKERHOSTNAME
* System Detected value:
* Default value: `DockSTARTer` (because we don't want it to be accidentally blank)
Description: All containers will default to having this hostname.

## DOCKERLOGGING_MAXFILE
* Default value: `10`
Description: 

## DOCKERLOGGING_MAXSIZE
* Default value: `200k`
Description: Maximum size in kilobytes that the log file will be before it is rotated.

## 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. 

## 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.

## MEDIADIR_AUDIOBOOKS
* System Detected value: `~/Audioooks`
* Default value: `/mnt/medialibrary/audiobooks`
Description: This is the default folder where all audiobooks are stored.

## MEDIADIR_BOOKS
* System Detected value: `~/Books`
* Default value: `/mnt/medialibrary/books`
Description: This is the default folder where all books are stored.

## MEDIADIR_COMICS
* System Detected value: `~/Comics`
* Default value: `/mnt/medialibrary/comics`
Description: This is the default folder where all comics are stored.

## 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.

## 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.

## 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.

## PGID
* System Detected value: Detects the ID of your group
* Default value: `1000` because this is the most common default on supported OS
Description: This value can be obtained by using `id $user`.

## PUID
* System Detected value: Detects the ID of your user
* Default value: `1000` because this is the most common default on supported OS
Description: This value can be obtained by using `id $user`.

## TZ
* System Detected value: Uses the value found in `/etc/timezone`
* Default value: `America/Chicago` because that's @nemchik's timezone (CST)

## LAN_NETWORK
* System Detected value:
* 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.

## NS1
* Default value: `1.1.1.1`
Description:

## NS2
* Default value: `8.8.8.8`
Description: 

## VPN_ENABLE
* Default value: `yes`
Description:

## VPN_OPTIONS
* Default value:
Description:

## VPN_OVPNDIR
* Default value: `~/.config/appdata/.openvpn`
Description: Directory where you will save your `ovpn` configuration so any VPN enabled containers use this VPN configuration.

## VPN_PASS
* Default value: No default
Description: This is the password you use to login to your VPN provider.

## VPN_PROV
* Default value: `custom`
Description: 

## VPN_USER
* Default value: No default value
Description: This is the username you use to login with to your VPN provider.

Feel free to fix, add, remove anything. The ones I left empty I just wasn't sure about.

[nemchik]

We're making amazing progress. There's still some missing info (descriptions). Also for all of the directories I want to explain where they get mounted inside the container.

ex:

DOCKERSHAREDDIR will be /shared in every container as it is standard across all of DS. This folder has no pre-designated purpose, so it can be used however you like.

DOWNLOADSDIR will be /downloads in any container that runs a downloader program. This is not meant to be the permanent location of files that belong in your media library (see below for MEDIADIR folders).

MEDIADIR_TV will be /tv in any container that would make use of your TV media library.

P.S. I don't really think the way I have typed it above is great for the actual page, just trying to get the point across here so we can document it. The idea is to reduce support questions and help people with the learning curve of how volumes in docker work. Basically I want to reduce users asking "I just started Plex and I can't see /mnt/myDisk/TV!"

I don't particularly want to name any specific apps, or purposes (ex I don't want to say "this is for torrenting" or "use radarr to rename/organize your movies") mostly because DS has always tried to allow the users to pick what they want to run, and torrenting or radarr would not apply to someone who runs DS just to get bitwarden installed for example.