From d594d4f8ae24736e91e11a9eda29000d1f7bd3e2 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Mon, 17 Nov 2025 08:54:19 +0100 Subject: [PATCH] docs: cleanup --- docker/common/defaults/settings.json | 5 ++-- www/docs/authentication.md | 44 ---------------------------- www/docs/troubleshooting.md | 9 ++++++ www/mkdocs.yml | 1 + 4 files changed, 12 insertions(+), 47 deletions(-) create mode 100644 www/docs/troubleshooting.md diff --git a/docker/common/defaults/settings.json b/docker/common/defaults/settings.json index 745a251c..cf7fb4ee 100644 --- a/docker/common/defaults/settings.json +++ b/docker/common/defaults/settings.json @@ -4,6 +4,5 @@ "address": "", "log": "stdout", "database": "/database/filebrowser.db", - "root": "/srv", - "token-expiration-time": "2h" -} \ No newline at end of file + "root": "/srv" +} diff --git a/www/docs/authentication.md b/www/docs/authentication.md index e2f18c77..365f9dac 100644 --- a/www/docs/authentication.md +++ b/www/docs/authentication.md @@ -47,47 +47,3 @@ We also provide a no authentication mechanism for users that want to use File Br ```sh filebrowser config set --auth.method=noauth ``` - -## Session Timeout - -By default, user sessions expire after **2 hours**. If you're uploading large files over slower connections, you may need to increase this timeout to prevent sessions from expiring mid-upload. You can configure the session timeout using the `token-expiration-time` setting. - -### Configuration File - -Add the setting to your configuration file (e.g., `/config/settings.json` in Docker): - -```json -{ - "token-expiration-time": "6h" -} -``` - -> [!IMPORTANT] -> -> The key must use kebab-case format: `token-expiration-time`. Valid duration formats include `"2h"`, `"30m"`, `"24h"`, or combinations like `"2h30m"`. - -### Environment Variable - -Set the corresponding environment variable: - -```sh -docker run -e FB_TOKEN_EXPIRATION_TIME=6h ... -``` - -### CLI Flag - -Pass the flag when starting File Browser: - -```sh -filebrowser --token-expiration-time 6h -``` - -### Updating an Existing Installation - -File Browser saves configuration values to the database during the **first run**. -Updating `settings.json` or environment variables later **will not affect an existing installation**. -To change the timeout, use: - -```sh -filebrowser config set --token-expiration-time 6h -``` diff --git a/www/docs/troubleshooting.md b/www/docs/troubleshooting.md new file mode 100644 index 00000000..a994957e --- /dev/null +++ b/www/docs/troubleshooting.md @@ -0,0 +1,9 @@ +# Troubleshooting + +## Session Timeout + +By default, user sessions expire after **2 hours**. If you're uploading large files over slower connections, you may need to increase this timeout to prevent sessions from expiring mid-upload. You can configure the session timeout using the `tokenExpirationTime` setting. + +You can either set this option during runtime by using the flag `--tokenExpirationTime`, the environment variable `FB_TOKEN_EXPIRATION_TIME`, or in your configuration file. If you want to persist this to the configuration, please use [`filebrowser config set`](cli/filebrowser-config-set.md). + +Valid duration formats include `"2h"`, `"30m"`, `"24h"`, or combinations like `"2h30m"`. diff --git a/www/mkdocs.yml b/www/mkdocs.yml index 7558c534..c71c6798 100644 --- a/www/mkdocs.yml +++ b/www/mkdocs.yml @@ -100,6 +100,7 @@ nav: - customization.md - authentication.md - command-execution.md + - Troubleshooting: troubleshooting.md - Deployment: deployment.md - Command Line Usage: - cli/filebrowser.md