github
/
filebrowser
mirror of https://github.com/filebrowser/filebrowser
1
0
Fork 0
Code Issues Releases Wiki Activity

chore(docs): update CLI documentation

pull/5560/head
Henrique Dias 2025-11-17 09:38:45 +01:00
parent f41585f039
commit 9bdc67c207
No known key found for this signature in database
3 changed files with 142 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
www/docs/cli/filebrowser-config-init.md
View File

@ -22,33 +22,31 @@ filebrowser config init [flags]
--auth.command string command for auth.method=hook --auth.command string command for auth.method=hook
--auth.header string HTTP header for auth.method=proxy --auth.header string HTTP header for auth.method=proxy
--auth.method string authentication type (default "json") --auth.method string authentication type (default "json")
-b, --baseurl string base url -b, --baseURL string base url
--branding.color string set the theme color --branding.color string set the theme color
--branding.disableExternal disable external links such as GitHub links --branding.disableExternal disable external links such as GitHub links
--branding.disableUsedPercentage disable used disk percentage graph --branding.disableUsedPercentage disable used disk percentage graph
--branding.files string path to directory with images and custom styles --branding.files string path to directory with images and custom styles
--branding.name string replace 'File Browser' by this name --branding.name string replace 'File Browser' by this name
--branding.theme string set the theme --branding.theme string set the theme
--cache-dir string file cache directory (disabled if empty)
-t, --cert string tls certificate -t, --cert string tls certificate
--commands strings a list of the commands a user can execute --commands strings a list of the commands a user can execute
--create-user-dir generate user's home directory automatically --createUserDir generate user's home directory automatically
--dateFormat use date format (true for absolute time, false for relative) --dateFormat use date format (true for absolute time, false for relative)
--dir-mode string mode bits that new directories are created with (default "0o750") --dirMode string mode bits that new directories are created with (default "0o750")
--disable-exec disables Command Runner feature (default true) --disableExec disables Command Runner feature (default true)
--disable-preview-resize disable resize of image previews --disablePreviewResize disable resize of image previews
--disable-thumbnails disable image thumbnails --disableThumbnails disable image thumbnails
--disable-type-detection-by-header disables type detection by reading file headers --disableTypeDetectionByHeader disables type detection by reading file headers
--file-mode string mode bits that new files are created with (default "0o640") --fileMode string mode bits that new files are created with (default "0o640")
-h, --help help for init -h, --help help for init
--hide-login-button hide login button from public pages
--hideDotfiles hide dotfiles --hideDotfiles hide dotfiles
--img-processors int image processors count (default 4) --hideLoginButton hide login button from public pages
-k, --key string tls key -k, --key string tls key
--locale string locale for users (default "en") --locale string locale for users (default "en")
--lockPassword lock password --lockPassword lock password
-l, --log string log output (default "stdout") -l, --log string log output (default "stdout")
--minimum-password-length uint minimum password length for new users (default 12) --minimumPasswordLength uint minimum password length for new users (default 12)
--perm.admin admin perm for users --perm.admin admin perm for users
--perm.create create perm for users (default true) --perm.create create perm for users (default true)
--perm.delete delete perm for users (default true) --perm.delete delete perm for users (default true)
@ -67,10 +65,9 @@ filebrowser config init [flags]
-s, --signup allow users to signup -s, --signup allow users to signup
--singleClick use single clicks only --singleClick use single clicks only
--socket string socket to listen to (cannot be used with address, port, cert nor key flags) --socket string socket to listen to (cannot be used with address, port, cert nor key flags)
--socket-perm uint32 unix socket file permissions (default 438)
--sorting.asc sorting by ascending order --sorting.asc sorting by ascending order
--sorting.by string sorting mode (name, size or modified) (default "name") --sorting.by string sorting mode (name, size or modified) (default "name")
--token-expiration-time string user session timeout (default "2h") --tokenExpirationTime string user session timeout (default "2h")
--tus.chunkSize uint the tus chunk size (default 10485760) --tus.chunkSize uint the tus chunk size (default 10485760)
--tus.retryCount uint16 the tus retry count (default 5) --tus.retryCount uint16 the tus retry count (default 5)
--viewMode string view mode for users (default "list") --viewMode string view mode for users (default "list")

25
www/docs/cli/filebrowser-config-set.md
View File

@ -19,33 +19,31 @@ filebrowser config set [flags]
--auth.command string command for auth.method=hook --auth.command string command for auth.method=hook
--auth.header string HTTP header for auth.method=proxy --auth.header string HTTP header for auth.method=proxy
--auth.method string authentication type (default "json") --auth.method string authentication type (default "json")
-b, --baseurl string base url -b, --baseURL string base url
--branding.color string set the theme color --branding.color string set the theme color
--branding.disableExternal disable external links such as GitHub links --branding.disableExternal disable external links such as GitHub links
--branding.disableUsedPercentage disable used disk percentage graph --branding.disableUsedPercentage disable used disk percentage graph
--branding.files string path to directory with images and custom styles --branding.files string path to directory with images and custom styles
--branding.name string replace 'File Browser' by this name --branding.name string replace 'File Browser' by this name
--branding.theme string set the theme --branding.theme string set the theme
--cache-dir string file cache directory (disabled if empty)
-t, --cert string tls certificate -t, --cert string tls certificate
--commands strings a list of the commands a user can execute --commands strings a list of the commands a user can execute
--create-user-dir generate user's home directory automatically --createUserDir generate user's home directory automatically
--dateFormat use date format (true for absolute time, false for relative) --dateFormat use date format (true for absolute time, false for relative)
--dir-mode string mode bits that new directories are created with (default "0o750") --dirMode string mode bits that new directories are created with (default "0o750")
--disable-exec disables Command Runner feature (default true) --disableExec disables Command Runner feature (default true)
--disable-preview-resize disable resize of image previews --disablePreviewResize disable resize of image previews
--disable-thumbnails disable image thumbnails --disableThumbnails disable image thumbnails
--disable-type-detection-by-header disables type detection by reading file headers --disableTypeDetectionByHeader disables type detection by reading file headers
--file-mode string mode bits that new files are created with (default "0o640") --fileMode string mode bits that new files are created with (default "0o640")
-h, --help help for set -h, --help help for set
--hide-login-button hide login button from public pages
--hideDotfiles hide dotfiles --hideDotfiles hide dotfiles
--img-processors int image processors count (default 4) --hideLoginButton hide login button from public pages
-k, --key string tls key -k, --key string tls key
--locale string locale for users (default "en") --locale string locale for users (default "en")
--lockPassword lock password --lockPassword lock password
-l, --log string log output (default "stdout") -l, --log string log output (default "stdout")
--minimum-password-length uint minimum password length for new users (default 12) --minimumPasswordLength uint minimum password length for new users (default 12)
--perm.admin admin perm for users --perm.admin admin perm for users
--perm.create create perm for users (default true) --perm.create create perm for users (default true)
--perm.delete delete perm for users (default true) --perm.delete delete perm for users (default true)
@ -64,10 +62,9 @@ filebrowser config set [flags]
-s, --signup allow users to signup -s, --signup allow users to signup
--singleClick use single clicks only --singleClick use single clicks only
--socket string socket to listen to (cannot be used with address, port, cert nor key flags) --socket string socket to listen to (cannot be used with address, port, cert nor key flags)
--socket-perm uint32 unix socket file permissions (default 438)
--sorting.asc sorting by ascending order --sorting.asc sorting by ascending order
--sorting.by string sorting mode (name, size or modified) (default "name") --sorting.by string sorting mode (name, size or modified) (default "name")
--token-expiration-time string user session timeout (default "2h") --tokenExpirationTime string user session timeout (default "2h")
--tus.chunkSize uint the tus chunk size (default 10485760) --tus.chunkSize uint the tus chunk size (default 10485760)
--tus.retryCount uint16 the tus retry count (default 5) --tus.retryCount uint16 the tus retry count (default 5)
--viewMode string view mode for users (default "list") --viewMode string view mode for users (default "list")

48
www/docs/cli/filebrowser.md
View File

@ -13,12 +13,14 @@ it. Don't worry: you don't need to setup a separate database server.
We're using Bolt DB which is a single file database and all managed We're using Bolt DB which is a single file database and all managed
by ourselves. by ourselves.
For this specific command, all the flags you have available (except For this command, all flags are available as environmental variables,
"config" for the configuration file), can be given either through except for "--config", which specifies the configuration file to use.
environment variables or configuration files. The environment variables are prefixed by "FB_" followed by the flag name in
UPPER_SNAKE_CASE. For example, the flag "--disablePreviewResize" is available
as FB_DISABLE_PREVIEW_RESIZE.
If you don't set "config", it will look for a configuration file called If "--config" is not specified, File Browser will look for a configuration
.filebrowser.{json, toml, yaml, yml} in the following directories: file named .filebrowser.{json, toml, yaml, yml} in the following directories:
- ./ - ./
- $HOME/ - $HOME/
@ -26,15 +28,11 @@ If you don't set "config", it will look for a configuration file called
The precedence of the configuration values are as follows: The precedence of the configuration values are as follows:
- flags - Flags
- environment variables - Environment variables
- configuration file - Configuration file
- database values - Database values
- defaults - Defaults
The environment variables are prefixed by "FB_" followed by the option
name in caps. So to set "database" via an env variable, you should
set FB_DATABASE.
Also, if the database path doesn't exist, File Browser will enter into Also, if the database path doesn't exist, File Browser will enter into
the quick setup mode and a new database will be bootstrapped and a new the quick setup mode and a new database will be bootstrapped and a new
@ -48,27 +46,27 @@ filebrowser [flags]
``` ```
-a, --address string address to listen on (default "127.0.0.1") -a, --address string address to listen on (default "127.0.0.1")
-b, --baseurl string base url -b, --baseURL string base url
--cache-dir string file cache directory (disabled if empty) --cacheDir string file cache directory (disabled if empty)
-t, --cert string tls certificate -t, --cert string tls certificate
-c, --config string config file path -c, --config string config file path
-d, --database string database path (default "./filebrowser.db") -d, --database string database path (default "./filebrowser.db")
--disable-exec disables Command Runner feature (default true) --disableExec disables Command Runner feature (default true)
--disable-preview-resize disable resize of image previews --disablePreviewResize disable resize of image previews
--disable-thumbnails disable image thumbnails --disableThumbnails disable image thumbnails
--disable-type-detection-by-header disables type detection by reading file headers --disableTypeDetectionByHeader disables type detection by reading file headers
-h, --help help for filebrowser -h, --help help for filebrowser
--img-processors int image processors count (default 4) --imageProcessors int image processors count (default 4)
-k, --key string tls key -k, --key string tls key
-l, --log string log output (default "stdout") -l, --log string log output (default "stdout")
--noauth use the noauth auther when using quick setup --noauth use the noauth auther when using quick setup
--password string hashed password for the first user when using quick config --password string hashed password for the first user when using quick setup
-p, --port string port to listen on (default "8080") -p, --port string port to listen on (default "8080")
-r, --root string root to prepend to relative paths (default ".") -r, --root string root to prepend to relative paths (default ".")
--socket string socket to listen to (cannot be used with address, port, cert nor key flags) --socket string socket to listen to (cannot be used with address, port, cert nor key flags)
--socket-perm uint32 unix socket file permissions (default 438) --socketPerm uint32 unix socket file permissions (default 438)
--token-expiration-time string user session timeout (default "2h") --tokenExpirationTime string user session timeout (default "2h")
--username string username for the first user when using quick config (default "admin") --username string username for the first user when using quick setup (default "admin")
``` ```
## See Also ## See Also