ghostwriters / dockstarter.com Goto Github PK

All references to ~/.docker/config need to be replaced with ~/.config/appdata

We need a page for Bitwarden explaining that the config folder will be created with root ownership but can be chowned to whatever user if desired.

The markdown lint tool we use has been superceded by https://github.com/DavidAnson/markdownlint which doesn't have a docker image. It should be easy enough to use this newer tool natively since it is officially published on npm. We wouldn't need to worry about falling behind on versions.

The mkdocs material image is maintained by the author of the mkdocs theme, so that's less of a concern. If needed we could use pip to install the latest version of mkdocs and the material theme. I'm less worried about this one.

Creating this as a reminder. GH actions isn't ga until late November.

Add wireguard override page

wireguard:
    image: linuxserver/wireguard
    hostname: ${DOCKERHOSTNAME}
    ports:
    - 51820:51820/udp
    sysctls:
      - net.ipv4.conf.all.src_valid_mark=1
    container_name: wireguard
    cap_add:
    - NET_ADMIN
    - SYS_MODULE
    environment:
    - PGID=${PGID}
    - PUID=${PUID}
    - TZ=${TZ}
    - SERVERURL=auto #optional
    - SERVERPORT=51820 #optional
    - PEERS=1 #optional
    - PEERDNS=auto #optional
    - INTERNAL_SUBNET=10.13.13.0 #optional
    logging:
      driver: json-file
      options:
        max-file: ${DOCKERLOGGING_MAXFILE}
        max-size: ${DOCKERLOGGING_MAXSIZE}
    restart: unless-stopped
    volumes:
    - /etc/localtime:/etc/localtime:ro
    - ${DOCKERCONFDIR}/wireguard:/config
    - /lib/modules:/lib/modules

We should make a page that links to any external guides we come across that involve using DockSTARTer in some capacity.

I wasn't sure if you did pull requests on the docs, so figured I'd just point this out in an issue.

In the SyncLounge documentation, I believe the wrong variable is used in the "Override Servers List" example.

The example shows:
version: "3.4" # this must match the version in docker-compose.yml services: synclounge: volumes: - ${DOCKERSHAREDDIR}/synclounge/servers.json:/defaults/servers.json

I would think that would actually be:
version: "3.4" # this must match the version in docker-compose.yml services: synclounge: volumes: - ${DOCKERCONFDIR}/synclounge/servers.json:/defaults/servers.json

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=