docs: cleanup
This commit is contained in:
parent
257c1e0d38
commit
d594d4f8ae
@ -4,6 +4,5 @@
|
|||||||
"address": "",
|
"address": "",
|
||||||
"log": "stdout",
|
"log": "stdout",
|
||||||
"database": "/database/filebrowser.db",
|
"database": "/database/filebrowser.db",
|
||||||
"root": "/srv",
|
"root": "/srv"
|
||||||
"token-expiration-time": "2h"
|
}
|
||||||
}
|
|
||||||
|
|||||||
@ -47,47 +47,3 @@ We also provide a no authentication mechanism for users that want to use File Br
|
|||||||
```sh
|
```sh
|
||||||
filebrowser config set --auth.method=noauth
|
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
|
|
||||||
```
|
|
||||||
|
|||||||
9
www/docs/troubleshooting.md
Normal file
9
www/docs/troubleshooting.md
Normal file
@ -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"`.
|
||||||
@ -100,6 +100,7 @@ nav:
|
|||||||
- customization.md
|
- customization.md
|
||||||
- authentication.md
|
- authentication.md
|
||||||
- command-execution.md
|
- command-execution.md
|
||||||
|
- Troubleshooting: troubleshooting.md
|
||||||
- Deployment: deployment.md
|
- Deployment: deployment.md
|
||||||
- Command Line Usage:
|
- Command Line Usage:
|
||||||
- cli/filebrowser.md
|
- cli/filebrowser.md
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user