Bot Updating Documentation

images/docker-lychee.md

@@ -10,7 +10,12 @@
 [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-lychee%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lychee/job/master/)
 [![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Flsio-ci.ams3.digitaloceanspaces.com%2Flinuxserver%2Flychee%2Flatest%2Fci-status.yml)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lychee/latest/index.html)
 
-[Lychee](https://lycheeorg.github.io/) is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely.
+[Lychee](https://lycheeorg.github.io/) is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely."
+
+### UPGRADE WARNING
+
+Please note that the upgrade process resets ALL password-protected albums. Any albums that were made public with a password will need to be re-secured.
+
 
 ## Supported Architectures
 
@@ -39,6 +44,10 @@ docker create \
   -e PUID=1000 \
   -e PGID=1000 \
   -e TZ=Europe/London \
+  -e DB_HOST=<yourdbhost> \
+  -e DB_USERNAME=<yourdbuser> \
+  -e DB_PASSWORD=<yourdbpass> \
+  -e DB_DATABASE=monica \
   -p 80:80 \
   -v </path/to/appdata/config>:/config \
   -v </path/to/pictures>:/pictures \
@@ -62,6 +71,10 @@ services:
       - PUID=1000
       - PGID=1000
       - TZ=Europe/London
+      - DB_HOST=<yourdbhost>
+      - DB_USERNAME=<yourdbuser>
+      - DB_PASSWORD=<yourdbpass>
+      - DB_DATABASE=monica
     volumes:
       - </path/to/appdata/config>:/config
       - </path/to/pictures>:/pictures
@@ -88,6 +101,10 @@ 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 |
 | `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
+| `DB_HOST=<yourdbhost>` | for specifying the database host |
+| `DB_USERNAME=<yourdbuser>` | for specifying the database user |
+| `DB_PASSWORD=<yourdbpass>` | for specifying the database password |
+| `DB_DATABASE=monica` | for specifying the database to be used |
 
 ### Volume Mappings (`-v`)
 
@@ -131,8 +148,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
 
 ## Application Setup
 
-Setup mysql/mariadb and account via the webui, accessible at http://SERVERIP:PORT  
-More info at [lychee](https://lycheeorg.github.io/).  
+Setup mysql/mariadb and account via the webui, accessible at http://SERVERIP:PORT
+More info at [lychee](https://lycheeorg.github.io/).
 
 
 ## Docker Mods
@@ -154,6 +171,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
 
 ## Versions
 
+* **10.07.20:** - Upgrade to Lychee v4 and rebased to alpine 3.12.
 * **19.12.19:** - Rebasing to alpine 3.11.
 * **23.10.19:** - Increase fastcgi timeouts (existing users need to manually update).
 * **19.09.19:** - Update project website url.