diff --git a/lsio/healthchecks/docker-compose.yaml b/lsio/healthchecks/docker-compose.yaml index 87f7be9..abc13d8 100644 --- a/lsio/healthchecks/docker-compose.yaml +++ b/lsio/healthchecks/docker-compose.yaml @@ -14,37 +14,37 @@ services: # for GroupID - PGID=${PGID:-100} # The site's top-level URL and the port it listens to if differrent than 80 or 443 (e.g., https://healthchecks.example.com:8000) - - SITE_ROOT= + - SITE_ROOT= # The site's name (e.g., "Example Corp HealthChecks") - - SITE_NAME= + - SITE_NAME= # From email for alerts - - DEFAULT_FROM_EMAIL= + - DEFAULT_FROM_EMAIL= # SMTP host - - EMAIL_HOST= + - EMAIL_HOST= # SMTP port - - EMAIL_PORT= + - EMAIL_PORT= # SMTP user - - EMAIL_HOST_USER= + - EMAIL_HOST_USER= # SMTP password - - EMAIL_HOST_PASSWORD= + - EMAIL_HOST_PASSWORD= # Use TLS for SMTP (`True` or `False`) - - EMAIL_USE_TLS= + - EMAIL_USE_TLS= # Superuser email - - SUPERUSER_EMAIL= + - SUPERUSER_EMAIL= # Superuser password - - SUPERUSER_PASSWORD= + - SUPERUSER_PASSWORD= # Defaults to False. Set to true to always override the `local_settings.py` file with values from environment variables. Do not set to True if you have made manual modifications to this file. - - REGENERATE_SETTINGS=True/False # optional - # Custom site logo URL - - SITE_LOGO_URL= # optional - # array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`) - - ALLOWED_HOSTS= # optional - # A secret key used for cryptographic signing. docker-healthchecks will generate a secure value if one does not exist - - SECRET_KEY= # optional + - REGENERATE_SETTINGS= # optional + # Full URL to custom site logo + - SITE_LOGO_URL= # optional + # Array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`) + - ALLOWED_HOSTS= # optional + # A secret key used for cryptographic signing. Will generate a secure value if one is not supplied + - SECRET_KEY= # optional # Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise) - - APPRISE_ENABLED=True/False # optional + - APPRISE_ENABLED= # optional volumes: - # database and healthchecks config directory volume mapping + # Database and healthchecks config directory - ${BASEDIR:-/volume1/docker}/healthchecks/config:/config ports: # will map the container's port 8000 to port 8000 on the host diff --git a/lsio/healthchecks/docker-run.sh b/lsio/healthchecks/docker-run.sh index fc31470..8dd8076 100644 --- a/lsio/healthchecks/docker-run.sh +++ b/lsio/healthchecks/docker-run.sh @@ -7,22 +7,22 @@ docker run -d \ --name=healthchecks \ -e PUID=${PUID:-1024} `# for UserID` \ -e PGID=${PGID:-100} `# for GroupID` \ - -e SITE_ROOT= `# The site's top-level URL and the port it listens to if differrent than 80 or 443 (e.g., https://healthchecks.example.com:8000)` \ - -e SITE_NAME= `# The site's name (e.g., "Example Corp HealthChecks")` \ - -e DEFAULT_FROM_EMAIL= `# From email for alerts` \ - -e EMAIL_HOST= `# SMTP host` \ - -e EMAIL_PORT= `# SMTP port` \ - -e EMAIL_HOST_USER= `# SMTP user` \ - -e EMAIL_HOST_PASSWORD= `# SMTP password` \ - -e EMAIL_USE_TLS= `# Use TLS for SMTP (`True` or `False`)` \ - -e SUPERUSER_EMAIL= `# Superuser email` \ - -e SUPERUSER_PASSWORD= `# Superuser password` \ - -e REGENERATE_SETTINGS=True/False `# optional` `# Defaults to False. Set to true to always override the `local_settings.py` file with values from environment variables. Do not set to True if you have made manual modifications to this file.` \ - -e SITE_LOGO_URL= `# optional` `# Custom site logo URL` \ - -e ALLOWED_HOSTS= `# optional` `# array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`)` \ - -e SECRET_KEY= `# optional` `# A secret key used for cryptographic signing. docker-healthchecks will generate a secure value if one does not exist` \ - -e APPRISE_ENABLED=True/False `# optional` `# Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise)` \ + -e SITE_ROOT= `# The site's top-level URL and the port it listens to if differrent than 80 or 443 (e.g., https://healthchecks.example.com:8000)` \ + -e SITE_NAME= `# The site's name (e.g., "Example Corp HealthChecks")` \ + -e DEFAULT_FROM_EMAIL= `# From email for alerts` \ + -e EMAIL_HOST= `# SMTP host` \ + -e EMAIL_PORT= `# SMTP port` \ + -e EMAIL_HOST_USER= `# SMTP user` \ + -e EMAIL_HOST_PASSWORD= `# SMTP password` \ + -e EMAIL_USE_TLS= `# Use TLS for SMTP (`True` or `False`)` \ + -e SUPERUSER_EMAIL= `# Superuser email` \ + -e SUPERUSER_PASSWORD= `# Superuser password` \ + -e REGENERATE_SETTINGS= `# optional` `# Defaults to False. Set to true to always override the `local_settings.py` file with values from environment variables. Do not set to True if you have made manual modifications to this file.` \ + -e SITE_LOGO_URL= `# optional` `# Full URL to custom site logo` \ + -e ALLOWED_HOSTS= `# optional` `# Array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`)` \ + -e SECRET_KEY= `# optional` `# A secret key used for cryptographic signing. Will generate a secure value if one is not supplied` \ + -e APPRISE_ENABLED= `# optional` `# Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise)` \ -p 8000:8000 `# will map the container's port 8000 to port 8000 on the host` \ - -v ${BASEDIR:-/volume1/docker}/healthchecks/config:/config `# database and healthchecks config directory volume mapping` \ + -v ${BASEDIR:-/volume1/docker}/healthchecks/config:/config `# Database and healthchecks config directory` \ --restart unless-stopped \ ghcr.io/linuxserver/healthchecks diff --git a/lsio/mariadb/docker-compose.yaml b/lsio/mariadb/docker-compose.yaml index d37f236..5fb14c0 100644 --- a/lsio/mariadb/docker-compose.yaml +++ b/lsio/mariadb/docker-compose.yaml @@ -12,7 +12,7 @@ services: - PUID=${PUID:-1024} # for GroupID - PGID=${PGID:-100} - # Set this to root password for installation (minimum 4 characters). + # Set this to root password for installation (minimum 4 characters & non-alphanumeric passwords must be properly escaped). - MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD # Specify a timezone to use for example Europe/Amsterdam - TZ=${TZ:-Europe/Amsterdam} @@ -20,7 +20,7 @@ services: - MYSQL_DATABASE=USER_DB_NAME # optional # This user will have superuser access to the database specified by MYSQL_DATABASE (do not use root here). - MYSQL_USER=MYSQL_USER # optional - # Set this to the password you want to use for you MYSQL_USER (minimum 4 characters). + # Set this to the password you want to use for you MYSQL_USER (minimum 4 characters & non-alphanumeric passwords must be properly escaped). - MYSQL_PASSWORD=DATABASE_PASSWORD # optional # Set this to ingest sql files from an http/https endpoint (comma seperated array). - REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sql # optional diff --git a/lsio/mariadb/docker-run.sh b/lsio/mariadb/docker-run.sh index e5ae38a..bcd6bdc 100644 --- a/lsio/mariadb/docker-run.sh +++ b/lsio/mariadb/docker-run.sh @@ -6,11 +6,11 @@ docker run -d \ --name=mariadb \ -e PUID=${PUID:-1024} `# for UserID` \ -e PGID=${PGID:-100} `# for GroupID` \ - -e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD `# Set this to root password for installation (minimum 4 characters).` \ + -e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD `# Set this to root password for installation (minimum 4 characters & non-alphanumeric passwords must be properly escaped).` \ -e TZ=${TZ:-Europe/Amsterdam} `# Specify a timezone to use for example Europe/Amsterdam` \ -e MYSQL_DATABASE=USER_DB_NAME `# optional` `# Specify the name of a database to be created on image startup.` \ -e MYSQL_USER=MYSQL_USER `# optional` `# This user will have superuser access to the database specified by MYSQL_DATABASE (do not use root here).` \ - -e MYSQL_PASSWORD=DATABASE_PASSWORD `# optional` `# Set this to the password you want to use for you MYSQL_USER (minimum 4 characters).` \ + -e MYSQL_PASSWORD=DATABASE_PASSWORD `# optional` `# Set this to the password you want to use for you MYSQL_USER (minimum 4 characters & non-alphanumeric passwords must be properly escaped).` \ -e REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sql `# optional` `# Set this to ingest sql files from an http/https endpoint (comma seperated array).` \ -p 3306:3306 `# Mariadb listens on this port.` \ -v ${BASEDIR:-/volume1/docker}/mariadb/config:/config `# Contains the db itself and all assorted settings.` \