Merge pull request #1276 from qdraw/feature/auto_documentation_create…

…_docusaurus_update

Documentation - Create Docusaurus - Upgrade dependencies

.github/workflows/auto-upgrade-documentation-create-docusaurus.yml

@@ -15,6 +15,12 @@ jobs:
       with:
         ref: master
 
+    - name: Setup Node.js environment
+      uses: actions/setup-node@v4
+      with:
+        node-version: 18
+        check-latest: true
+
     - name: 'Update docusaurus'
       id: clientapp_create_docusaurus_update
       working-directory: ./starsky-tools/build-tools

.github/workflows/documentation-linux-ci.yml

@@ -25,7 +25,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 16.x]
+        node-version: [18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v4

documentation/docs/developer-guide/api/readme.md

@@ -42,7 +42,7 @@ This document is auto generated
 | __/api/export/create-zip__                        | POST  | Export source files to an zip archive                                           |
 | _Parameters: f (subPath to files), collections (enable files with the same name (before the extension)), thumbnail                        _ |
 | _ (export thumbnails)                                                                                                                     _ |
-| __/api/export/zip/{f}.zip__                       | GET   | Get the exported zip, but first call 'createZip'use for example this url: /ex...|
+| __/api/export/zip/\{f\}.zip__                     | GET   | Get the exported zip, but first call 'createZip'use for example this url: /ex...|
 | __/api/geo/status__                               | GET   | Get Geo sync status                                                             |
 | __/api/geo/sync__                                 | POST  | Reverse lookup for Geo Information and/or add Geo location based on a GPX fil...|
 | __/api/geo-reverse-lookup__                       | GET   | Reverse geo lookup                                                              |
@@ -97,12 +97,12 @@ This document is auto generated
 | __/api/suggest/inflate__                          | GET   | To fill the cache with the data (only if cache is not already filled)           |
 | __/api/synchronize__                              | POST  | Faster API to Check if directory is changed (not recursive)                     |
 | __/api/synchronize__                              | GET   | Faster API to Check if directory is changed (not recursive)                     |
-| __/api/thumbnail/small/{f}__                      | GET   | Get thumbnail for index pages (300 px or 150px or 1000px (based on whats there))|
-| __/api/thumbnail/list-sizes/{f}__                 | GET   | Get overview of what exists by name                                             |
-| __/api/thumbnail/{f}__                            | GET   | Get thumbnail with fallback to original source image.Return source image when...|
+| __/api/thumbnail/small/\{f\}__                    | GET   | Get thumbnail for index pages (300 px or 150px or 1000px (based on whats there))|
+| __/api/thumbnail/list-sizes/\{f\}__               | GET   | Get overview of what exists by name                                             |
+| __/api/thumbnail/\{f\}__                          | GET   | Get thumbnail with fallback to original source image.Return source image when...|
 | _Parameters: f (one single fileHash (NOT path)), filePath (fallback FilePath), isSingleItem (true = load original),                       _ |
 | _ json (text as output), extraLarge (give preference to extraLarge over large image)                                                      _ |
-| __/api/thumbnail/zoom/{f}@{z}__                   | GET   | Get zoomed in image by fileHash.At the moment this is the source image          |
+| __/api/thumbnail/zoom/\{f\}@\{z\}__               | GET   | Get zoomed in image by fileHash.At the moment this is the source image          |
 | __/api/thumbnail-generation__                     | POST  | Create thumbnails for a folder in the background                                |
 | __/api/trash/detect-to-use-system-trash__         | GET   | Is the system trash supported                                                   |
 | __/api/trash/move-to-trash__                      | POST  | (beta) Move a file to the trash                                                 |

documentation/docs/developer-guide/security-headers.md

@@ -4,9 +4,9 @@
 
 The HTTP protocol supports a set of security headers to control certain aspects of (browser) behaviour. Below is a summary of the most important security headers and their suggested/required value. 
 
-There are sites like <https://securityheaders.io/> and <https://internet.nl/> where you can scan your site to see how well it scores. More details on scanning/monitoring below.
+There are sites like https://securityheaders.io/ and https://internet.nl/ where you can scan your site to see how well it scores. More details on scanning/monitoring below.
 
-The links in the table below also provide examples on how to set these headers in popular webservers like Apache and nginx .
+The links in the table below also provide examples on how to set these headers in popular web servers like Apache and nginx .
 
 This page is inspired by the [OWASP Secure Headers Project](https://owasp.org/www-project-secure-headers/#configuration-proposal) and their [Configuration Proposal](https://owasp.org/www-project-secure-headers/#configuration-proposal). We will make more of those mandatory for iO over time, so please up to speed with the below headers.
 
@@ -36,15 +36,15 @@ Please make sure headers are not set multiple times, as this can lead to unpredi
 
 Sites:
 
-- <https://securityheaders.com/>
-- <https://internet.nl/>
-- <https://dev.ssllabs.com/ssltest/analyze.html>
-- <https://chrome.google.com/webstore/detail/security-header-extension/nggplilppojikmgpmlecpcikpoiffinp>
+- https://securityheaders.com/
+- https://internet.nl/
+- https://dev.ssllabs.com/ssltest/analyze.html
+- https://chrome.google.com/webstore/detail/security-header-extension/nggplilppojikmgpmlecpcikpoiffinp
 
 Scripts:
 
-- <https://github.com/santoru/shcheck>
+- https://github.com/santoru/shcheck
 
 For the Content-Security-Policy (CSP) it is a lot more complicated to check. You can use these to check the CSP:
 
-- <https://csp-evaluator.withgoogle.com/>
+- https://csp-evaluator.withgoogle.com/

documentation/docs/getting-started/docker/docker-compose.md

@@ -122,7 +122,7 @@ Enabling [public mode](../config-options.md) will disable authentication.
     It can be helpful to [keep Docker running in the foreground while debugging](../troubleshooting/docker.md#viewing-logs) so that log messages are displayed directly. To do this, omit the `-d` parameter when restarting.
     Should the server already be running, or you see no errors, you may have started it
     on a different host and/or port. There could also be an [issue with your browser,
-    ad blocker, or firewall settings](../troubleshooting/index.md#connection-fails).
+    [ad blocker, or firewall settings](../troubleshooting/index.md).
 
 
 The server port and other [config options](../config-options.md) can be changed in `docker-compose.yml` at any time.
@@ -138,7 +138,7 @@ docker compose up -d
 Our [First Steps 👣](../first-steps.md) tutorial guides you through the user interface and settings to ensure your library is indexed according to your individual preferences.
 
 > **Note**<br />
-    Ensure [there is enough disk space available](../troubleshooting/docker.md#disk-space) for creating thumbnails and [verify filesystem permissions](../troubleshooting/docker.md#file-permissions)
+    Ensure [there is enough disk space available](../troubleshooting/docker.md#disk-space) for creating thumbnails and [verify filesystem permissions](../troubleshooting/docker.md)
     before starting to index: Files in the *originals* folder must be readable, while the *storage* folder
     including all subdirectories must be readable and writeable.
 

documentation/docs/getting-started/troubleshooting/index.md

@@ -16,7 +16,7 @@ Before reporting a bug, whould you please the following things:
 - [ ] Check the logs for messages like *disk full*, *disk quota exceeded*, *no space left on device*, *read-only file system*, *error creating path*, *wrong permissions*, *no route to host*, *connection failed*, and *killed*:
     - [ ] If a service has been "killed" or otherwise automatically terminated, this points to a [memory problem](docker.md#adding-swap) (add swap and/or memory; remove or increase usage limits)
     - [ ] In case the logs show "disk full", "quota exceeded", or "no space left" errors, either [the disk containing the *storage* folder is full](docker.md#disk-space) (add storage) or a disk usage limit is configured (remove or increase it)
-    - [ ] Errors such as "read-only file system", "error creating path", or "wrong permissions" indicate a [filesystem permission problem](docker.md#file-permissions)
+    - [ ] Errors such as "read-only file system", "error creating path", or "wrong permissions" indicate a [filesystem permission problem](docker.md)
     - [ ] It may help to [add the `:z` mount flag to volumes](https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label) when using SELinux (RedHat/Fedora)
     - [ ] Log messages that contain "no route to host" indicate a [problem with the database](mariadb.md) or Docker network configuration (follow our [examples](../docker/docker-compose.md))
 - [ ] Make sure you are using the correct protocol (default is `http`), port (default is `4823`), and host (default is `localhost`):
@@ -29,7 +29,7 @@ Before reporting a bug, whould you please the following things:
 - [ ] Go through the [checklist for fatal server errors](#fatal-server-errors)
 
 Should MariaDB get stuck in a restart loop and Starsky can't connect to it, this indicates a [memory](docker.md#adding-swap),
-[filesystem](docker.md#file-permissions), or other [permission issue](docker.md#kernel-security):
+[filesystem](docker.md), or other [permission issue](docker.md#kernel-security):
 
 ```
 mariadb: mysqld: ready for connections.
@@ -90,7 +90,7 @@ Fatal errors are often caused by one of the following conditions:
 - [ ] You have accidentally [mounted the wrong folders](../docker/docker-compose.md#volumes) (update config and restart)
 - [ ] There is disk space left, but a usage or the [inode limit](https://serverfault.com/questions/104986/what-is-the-maximum-number-of-files-a-file-system-can-contain) has been reached (change it)
 - [ ] You are using a [filesystem or network drive with a file size limit](https://thegeekpage.com/fix-the-file-size-exceeds-the-limit-allowed-and-cannot-be-saved/) (change settings or storage)
-- [ ] The *storage* folder [is not writable or mounted read-only](docker.md#file-permissions) (change [permissions](docker.md#file-permissions))
+- [ ] The *storage* folder [is not writable or mounted read-only](docker.md) (change [permissions](docker.md))
 - [ ] [Symbolic links](https://en.wikipedia.org/wiki/Symbolic_link) were mounted or used within a *storage* folder (replace with actual paths)
 - [ ] The [server is low on memory](../readme.mdx#system-requirements) (add memory)
 - [ ] You didn't [configure at least 4 GB of swap space](docker.md#adding-swap) (add swap)
@@ -110,7 +110,7 @@ We recommend checking your [Docker Logs](docker.md#viewing-logs) for messages li
 
 - [ ] If a service has been "killed" or otherwise automatically terminated, this points to a [memory problem](docker.md#adding-swap) (add swap and/or memory; remove or increase usage limits)
 - [ ] In case the logs show "disk full", "quota exceeded", or "no space left" errors, either [the disk containing the *storage* folder is full](docker.md#disk-space) (add storage) or a disk usage limit is configured (remove or increase it)
-- [ ] Errors such as "read-only file system", "error creating path", or "wrong permissions" indicate a [filesystem permission problem](docker.md#file-permissions) 
+- [ ] Errors such as "read-only file system", "error creating path", or "wrong permissions" indicate a [filesystem permission problem](docker.md) 
 - [ ] Log messages that contain "no route to host" indicate a [problem with the database](mariadb.md) or network configuration (follow our [examples](../docker/docker-compose.md))
 
 *Start a full rescan if necessary, for example, if it looks like [thumbnails](index.md#broken-thumbnails) or [pictures are missing](index.md#missing-pictures).*
@@ -136,15 +136,15 @@ If you have indexed your library and some images or videos are missing, first [c
 In case the application logs don't contain anything helpful:
 
 - [ ] The files exceed the [size limit in megabyte or the resolution limit in megapixels](../config-options.md#storage)
-- [ ] The files have [bad filesystem permissions or the wrong owner](docker.md#file-permissions), so they cannot be opened
+- [ ] The files have [bad filesystem permissions or the wrong owner](docker.md), so they cannot be opened
 - [ ] The file type is generally unsupported
 - [ ] The file type is generally supported, but a specific feature or codec is missing
 - [ ] The indexer has skipped the files because they are exact duplicates
 - [ ] The files are ignored based on pattern in a `appsettings.json` file
 - [ ] They are hidden because image could not be read:
     - [ ] The file is broken, e.g. because of *short Huffman data* (try to fix it)
     - [ ] [Your (virtual) server disk is full](docker.md#disk-space) (add storage)
-    - [ ] [The *storage* folder is not writable](docker.md#file-permissions) (change [permissions](docker.md#file-permissions))
+    - [ ] [The *storage* folder is not writable](docker.md) (change [permissions](docker.md))
     - [ ] A disk usage or the [inode limit](https://serverfault.com/questions/104986/what-is-the-maximum-number-of-files-a-file-system-can-contain) has been reached (remove or increase it)
 - [ ] Multiple files were [stacked](../../features/stacks.md) based on their metadata or file names
 - [ ] You try to index a shared drive on a remote server, but the server is offline
@@ -178,7 +178,7 @@ In case the application logs don't contain anything helpful:
 - [ ] You browse non-JPEG files in *Library > Originals* which have an icon but no preview
 - [ ] [Your (virtual) server disk is full](docker.md#disk-space) (add storage)
 - [ ] A disk usage or the [inode limit](https://serverfault.com/questions/104986/what-is-the-maximum-number-of-files-a-file-system-can-contain) has been reached (remove or increase it)
-- [ ] The *storage* folder [is not writable or mounted read-only](docker.md#file-permissions) (change [permissions](docker.md#file-permissions))
+- [ ] The *storage* folder [is not writable or mounted read-only](docker.md) (change [permissions](docker.md))
 - [ ] Files were deleted manually, for example to free up disk space
 - [ ] Files can't be opened, e.g. because the file system permissions have been changed
 - [ ] Files are stored on an unreliable device such as a USB flash drive or a shared network folder
@@ -195,7 +195,7 @@ We also recommend checking your [Docker Logs](docker.md#viewing-logs) for messag
 - [ ] If a service has been "killed" or otherwise automatically terminated, this points to a
 memory problem
 - [ ] In case the logs show "disk full", "quota exceeded", or "no space left" errors, either [the disk containing the *storage* folder is full](docker.md#disk-space) (add storage) or a disk usage limit is configured (remove or increase it)
-- [ ] Errors such as "read-only file system", "error creating path", or "wrong permissions" indicate a [filesystem permission problem](docker.md#file-permissions)
+- [ ] Errors such as "read-only file system", "error creating path", or "wrong permissions" indicate a [filesystem permission problem](docker.md)
 
 *Depending on the cause of the problem, you may need to perform a full rescan once the issue is resolved.*
 
@@ -208,7 +208,7 @@ If videos do not play and/or you only see a white/black area when you open a vid
 - [ ] An ad blocker or other plugins block requests (disable them or add an exception)
 - [ ] [Your (virtual) server disk is full](docker.md#disk-space) (add storage)
 - [ ] A disk usage or the [inode limit](https://serverfault.com/questions/104986/what-is-the-maximum-number-of-files-a-file-system-can-contain) has been reached (remove or increase it)
-- [ ] The *storage* folder [is not writable or mounted read-only](docker.md#file-permissions) (change [permissions](docker.md#file-permissions))
+- [ ] The *storage* folder [is not writable or mounted read-only](docker.md) (change [permissions](docker.md))
 - [ ] Files are stored on an unreliable device such as a USB flash drive or a shared network folder (check if the files are accessible)
 - [ ] Your browser cannot communicate properly with the server, e.g. because a [Reverse Proxy](../proxies/nginx.md), VPN, or CDN is configured incorrectly (check its configuration and try without)
 - [ ] There are other network problems caused by a proxy, firewall, or unstable connection (try a direct connection)

documentation/docs/getting-started/troubleshooting/windows.md

@@ -9,7 +9,7 @@ If you experience poor performance when indexing large libraries stored on NTFS:
 - [ ] [exFat](https://en.wikipedia.org/wiki/ExFAT) can be faster than NTFS, especially on external SSD drives with a lot of small files.
 - [ ] Windows 10 allows physical disks formatted with the Linux ext4 file system to be mounted directly in WSL 2, which may be an option for some use cases.[^4]
 
-[^1]: <https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2003/cc781134(v=ws.10)?redirectedfrom=MSDN#last-access-time>
-[^2]: <https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2003/cc781134(v=ws.10)?redirectedfrom=MSDN#how-ntfs-generates-short-file-names>
-[^3]: <https://stackoverflow.com/a/9600126>
-[^4]: <https://www.bleepingcomputer.com/news/microsoft/windows-10-now-lets-you-mount-linux-ext4-filesystems-in-wsl-2/>
+[^1]: https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2003/cc781134(v=ws.10)?redirectedfrom=MSDN#last-access-time
+[^2]: https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2003/cc781134(v=ws.10)?redirectedfrom=MSDN#how-ntfs-generates-short-file-names
+[^3]: https://stackoverflow.com/a/9600126
+[^4]: https://www.bleepingcomputer.com/news/microsoft/windows-10-now-lets-you-mount-linux-ext4-filesystems-in-wsl-2/