docs: documentation for remember-me functionality

DOCKERHUB.md

@@ -76,6 +76,8 @@ For example, `-p 8080:80` would expose port `80` from inside the container to be
 | `--mount type=bind,source=/path/to/books,target=/books`   | Location of books library on disk                                     |
 | `-e KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS`            | Comma-separated list of patterns to exclude directories from the scan |
 
+Please check the Komga [documentation](https://github.com/gotson/komga#configuration) for an exhaustive list of supported parameters.
+
 ## User / Group Identifiers
 
 When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user ID and group ID.

README.md

@@ -60,7 +60,9 @@ You can also use some optional configuration keys:
 - `KOMGA_LIBRARIES_SCAN_CRON` / `komga.libraries-scan-cron`: a [Spring cron expression](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/scheduling/support/CronSequenceGenerator.html) for libraries periodic rescans. `0 0 * * * ?` will rescan every hour. `0 */15 * * * ?` will rescan every 15 minutes. Defaults to `0 */15 * * * ?` in `prod` profile.
 - `KOMGA_THREADS_ANALYZER` / `komga.threads.analyzer`: the number of worker threads used for analyzing books. Defaults to `2`. You can experiment to get better performance.
 - `KOMGA_LIBRARIES_SCAN_DIRECTORY_EXCLUSIONS` / `komga.libraries-scan-directory-exclusions`: a list of patterns to exclude directories from the scan. If the full path contains any of the patterns, the directory will be ignored. If using the environment variable form use a comma-separated list.
-- `KOMGA_FILESYSTEM_SCANNER_FORCE_DIRECTORY_MODIFIED_TIME` / `komga.filesystem-scanner-force-directory-modified-time`: if set to `true`, it will force the last modified time of a directory as the maximum from its own last modified time and the last modified time from all the books inside the directory. This should be used only if your filesystem does not update the last modified time of a directory when files inside it are modified (Google Drive for instance).   
+- `KOMGA_FILESYSTEM_SCANNER_FORCE_DIRECTORY_MODIFIED_TIME` / `komga.filesystem-scanner-force-directory-modified-time`: if set to `true`, it will force the last modified time of a directory as the maximum from its own last modified time and the last modified time from all the books inside the directory. This should be used only if your filesystem does not update the last modified time of a directory when files inside it are modified (Google Drive for instance).
+- `KOMGA_REMEMBER_ME_KEY` / `komga.remember-me.key`: a unique key. If set, the remember-me auto-login feature will be activated, and will generate a cookie with encoded login information to perform auto-login.
+- `KOMGA_REMEMBER_ME_VALIDITY` / `komga.remember-me.validity`: the validity, in seconds, of the generated remember-me cookie. Defaults to 2 weeks.
 
 ## What does it do?
 
@@ -181,7 +183,7 @@ Komga offers a standard OPDS feed, it is available at `/opds/v1.2/catalog`.
 The OPDS feed also supports:
 
 - OpenSearch functionality, to search by `Series`
-- [OPDS Page Streaming Extension 1.0](https://vaemendis.net/opds-pse/) 
+- [OPDS Page Streaming Extension 1.0](https://vaemendis.net/opds-pse/)
 
 ## Credits
 

doc/sample-configuration/unix/application.yml

@@ -4,6 +4,9 @@ komga:
     - "#recycle" #synology NAS recycle bin
     - "@eaDir"   #synology NAS index/metadata folders
   filesystem-scanner-force-directory-modified-time: false #set to true only if newly added books in existing series are not scanned (ie Google Drive)
+  remember-me:
+    key: changeMe! #required to activate the remember-me auto-login via cookies
+    validity: 2592000 #validity of the cookie in seconds, here 1 month
 spring:
   datasource:
     url: jdbc:h2:./komga-database.h2 #database will be located in the current directory

doc/sample-configuration/windows/application.yml

@@ -4,6 +4,9 @@ komga:
     - "#recycle" #synology NAS recycle bin
     - "@eaDir"   #synology NAS index/metadata folders
   filesystem-scanner-force-directory-modified-time: false #set to true only if newly added books in existing series are not scanned (ie Google Drive)
+  remember-me:
+    key: changeMe! #required to activate the remember-me auto-login via cookies
+    validity: 2592000 #validity of the cookie in seconds, here 1 month
 spring:
   datasource:
     url: jdbc:h2:./komga-database.h2 #database will be located in the current directory