diff --git a/images/docker-healthchecks.md b/images/docker-healthchecks.md index c628b48b2..cd5a36e42 100644 --- a/images/docker-healthchecks.md +++ b/images/docker-healthchecks.md @@ -53,23 +53,23 @@ services: environment: - PUID=1000 - PGID=1000 - - SITE_ROOT= - - SITE_NAME= - - DEFAULT_FROM_EMAIL= - - EMAIL_HOST= - - EMAIL_PORT= - - EMAIL_HOST_USER= - - EMAIL_HOST_PASSWORD= - - EMAIL_USE_TLS= - - SUPERUSER_EMAIL= - - SUPERUSER_PASSWORD= - - REGENERATE_SETTINGS=True/False #optional - - SITE_LOGO_URL= #optional - - ALLOWED_HOSTS= #optional - - SECRET_KEY= #optional - - APPRISE_ENABLED=True/False #optional + - SITE_ROOT= + - SITE_NAME= + - DEFAULT_FROM_EMAIL= + - EMAIL_HOST= + - EMAIL_PORT= + - EMAIL_HOST_USER= + - EMAIL_HOST_PASSWORD= + - EMAIL_USE_TLS= + - SUPERUSER_EMAIL= + - SUPERUSER_PASSWORD= + - REGENERATE_SETTINGS= #optional + - SITE_LOGO_URL= #optional + - ALLOWED_HOSTS= #optional + - SECRET_KEY= #optional + - APPRISE_ENABLED= #optional volumes: - - :/config + - /path/to/data:/config ports: - 8000:8000 restart: unless-stopped @@ -82,23 +82,23 @@ docker run -d \ --name=healthchecks \ -e PUID=1000 \ -e PGID=1000 \ - -e SITE_ROOT= \ - -e SITE_NAME= \ - -e DEFAULT_FROM_EMAIL= \ - -e EMAIL_HOST= \ - -e EMAIL_PORT= \ - -e EMAIL_HOST_USER= \ - -e EMAIL_HOST_PASSWORD= \ - -e EMAIL_USE_TLS= \ - -e SUPERUSER_EMAIL= \ - -e SUPERUSER_PASSWORD= \ - -e REGENERATE_SETTINGS=True/False `#optional` \ - -e SITE_LOGO_URL= `#optional` \ - -e ALLOWED_HOSTS= `#optional` \ - -e SECRET_KEY= `#optional` \ - -e APPRISE_ENABLED=True/False `#optional` \ + -e SITE_ROOT= \ + -e SITE_NAME= \ + -e DEFAULT_FROM_EMAIL= \ + -e EMAIL_HOST= \ + -e EMAIL_PORT= \ + -e EMAIL_HOST_USER= \ + -e EMAIL_HOST_PASSWORD= \ + -e EMAIL_USE_TLS= \ + -e SUPERUSER_EMAIL= \ + -e SUPERUSER_PASSWORD= \ + -e REGENERATE_SETTINGS= `#optional` \ + -e SITE_LOGO_URL= `#optional` \ + -e ALLOWED_HOSTS= `#optional` \ + -e SECRET_KEY= `#optional` \ + -e APPRISE_ENABLED= `#optional` \ -p 8000:8000 \ - -v :/config \ + -v /path/to/data:/config \ --restart unless-stopped \ lscr.io/linuxserver/healthchecks:latest ``` @@ -119,27 +119,27 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | -| `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) | -| `SITE_NAME=` | The site's name (e.g., "Example Corp HealthChecks") | -| `DEFAULT_FROM_EMAIL=` | From email for alerts | -| `EMAIL_HOST=` | SMTP host | -| `EMAIL_PORT=` | SMTP port | -| `EMAIL_HOST_USER=` | SMTP user | -| `EMAIL_HOST_PASSWORD=` | SMTP password | -| `EMAIL_USE_TLS=` | Use TLS for SMTP (`True` or `False`) | -| `SUPERUSER_EMAIL=` | Superuser email | -| `SUPERUSER_PASSWORD=` | Superuser password | -| `REGENERATE_SETTINGS=True/False` | 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. | -| `SITE_LOGO_URL=` | Custom site logo URL | -| `ALLOWED_HOSTS=` | array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`) | -| `SECRET_KEY=` | A secret key used for cryptographic signing. docker-healthchecks will generate a secure value if one does not exist | -| `APPRISE_ENABLED=True/False` | Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise) | +| `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) | +| `SITE_NAME=` | The site's name (e.g., "Example Corp HealthChecks") | +| `DEFAULT_FROM_EMAIL=` | From email for alerts | +| `EMAIL_HOST=` | SMTP host | +| `EMAIL_PORT=` | SMTP port | +| `EMAIL_HOST_USER=` | SMTP user | +| `EMAIL_HOST_PASSWORD=` | SMTP password | +| `EMAIL_USE_TLS=` | Use TLS for SMTP (`True` or `False`) | +| `SUPERUSER_EMAIL=` | Superuser email | +| `SUPERUSER_PASSWORD=` | Superuser password | +| `REGENERATE_SETTINGS=` | 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. | +| `SITE_LOGO_URL=` | Full URL to custom site logo | +| `ALLOWED_HOSTS=` | Array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`) | +| `SECRET_KEY=` | A secret key used for cryptographic signing. Will generate a secure value if one is not supplied | +| `APPRISE_ENABLED=` | Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise) | ### Volume Mappings (`-v`) | Volume | Function | | :----: | --- | -| `/config` | database and healthchecks config directory volume mapping | +| `/config` | Database and healthchecks config directory | #### Miscellaneous Options @@ -195,6 +195,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **11.10.22:** - Rebase to Alpine 3.16, migrate to s6v3. * **27.09.22:** - Fix sending of Email Reports * **08.01.22:** - Fix CSRF setting for Django 4.0 (introduced in v1.25.0) * **11.11.21:** - Add Apprise to Docker as in v1.24.0