diff --git a/www/docs/cli/filebrowser-config-init.md b/www/docs/cli/filebrowser-config-init.md index 126082d0..6ea484e6 100644 --- a/www/docs/cli/filebrowser-config-init.md +++ b/www/docs/cli/filebrowser-config-init.md @@ -17,63 +17,60 @@ filebrowser config init [flags] ## Options ``` - --aceEditorTheme string ace editor's syntax highlighting theme for users - -a, --address string address to listen on (default "127.0.0.1") - --auth.command string command for auth.method=hook - --auth.header string HTTP header for auth.method=proxy - --auth.method string authentication type (default "json") - -b, --baseurl string base url - --branding.color string set the theme color - --branding.disableExternal disable external links such as GitHub links - --branding.disableUsedPercentage disable used disk percentage graph - --branding.files string path to directory with images and custom styles - --branding.name string replace 'File Browser' by this name - --branding.theme string set the theme - --cache-dir string file cache directory (disabled if empty) - -t, --cert string tls certificate - --commands strings a list of the commands a user can execute - --create-user-dir generate user's home directory automatically - --dateFormat use date format (true for absolute time, false for relative) - --dir-mode string mode bits that new directories are created with (default "0o750") - --disable-exec disables Command Runner feature (default true) - --disable-preview-resize disable resize of image previews - --disable-thumbnails disable image thumbnails - --disable-type-detection-by-header disables type detection by reading file headers - --file-mode string mode bits that new files are created with (default "0o640") - -h, --help help for init - --hide-login-button hide login button from public pages - --hideDotfiles hide dotfiles - --img-processors int image processors count (default 4) - -k, --key string tls key - --locale string locale for users (default "en") - --lockPassword lock password - -l, --log string log output (default "stdout") - --minimum-password-length uint minimum password length for new users (default 12) - --perm.admin admin perm for users - --perm.create create perm for users (default true) - --perm.delete delete perm for users (default true) - --perm.download download perm for users (default true) - --perm.execute execute perm for users (default true) - --perm.modify modify perm for users (default true) - --perm.rename rename perm for users (default true) - --perm.share share perm for users (default true) - -p, --port string port to listen on (default "8080") - --recaptcha.host string use another host for ReCAPTCHA. recaptcha.net might be useful in China (default "https://www.google.com") - --recaptcha.key string ReCaptcha site key - --recaptcha.secret string ReCaptcha secret - -r, --root string root to prepend to relative paths (default ".") - --scope string scope for users (default ".") - --shell string shell command to which other commands should be appended - -s, --signup allow users to signup - --singleClick use single clicks only - --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.by string sorting mode (name, size or modified) (default "name") - --token-expiration-time string user session timeout (default "2h") - --tus.chunkSize uint the tus chunk size (default 10485760) - --tus.retryCount uint16 the tus retry count (default 5) - --viewMode string view mode for users (default "list") + --aceEditorTheme string ace editor's syntax highlighting theme for users + -a, --address string address to listen on (default "127.0.0.1") + --auth.command string command for auth.method=hook + --auth.header string HTTP header for auth.method=proxy + --auth.method string authentication type (default "json") + -b, --baseURL string base url + --branding.color string set the theme color + --branding.disableExternal disable external links such as GitHub links + --branding.disableUsedPercentage disable used disk percentage graph + --branding.files string path to directory with images and custom styles + --branding.name string replace 'File Browser' by this name + --branding.theme string set the theme + -t, --cert string tls certificate + --commands strings a list of the commands a user can execute + --createUserDir generate user's home directory automatically + --dateFormat use date format (true for absolute time, false for relative) + --dirMode string mode bits that new directories are created with (default "0o750") + --disableExec disables Command Runner feature (default true) + --disablePreviewResize disable resize of image previews + --disableThumbnails disable image thumbnails + --disableTypeDetectionByHeader disables type detection by reading file headers + --fileMode string mode bits that new files are created with (default "0o640") + -h, --help help for init + --hideDotfiles hide dotfiles + --hideLoginButton hide login button from public pages + -k, --key string tls key + --locale string locale for users (default "en") + --lockPassword lock password + -l, --log string log output (default "stdout") + --minimumPasswordLength uint minimum password length for new users (default 12) + --perm.admin admin perm for users + --perm.create create perm for users (default true) + --perm.delete delete perm for users (default true) + --perm.download download perm for users (default true) + --perm.execute execute perm for users (default true) + --perm.modify modify perm for users (default true) + --perm.rename rename perm for users (default true) + --perm.share share perm for users (default true) + -p, --port string port to listen on (default "8080") + --recaptcha.host string use another host for ReCAPTCHA. recaptcha.net might be useful in China (default "https://www.google.com") + --recaptcha.key string ReCaptcha site key + --recaptcha.secret string ReCaptcha secret + -r, --root string root to prepend to relative paths (default ".") + --scope string scope for users (default ".") + --shell string shell command to which other commands should be appended + -s, --signup allow users to signup + --singleClick use single clicks only + --socket string socket to listen to (cannot be used with address, port, cert nor key flags) + --sorting.asc sorting by ascending order + --sorting.by string sorting mode (name, size or modified) (default "name") + --tokenExpirationTime string user session timeout (default "2h") + --tus.chunkSize uint the tus chunk size (default 10485760) + --tus.retryCount uint16 the tus retry count (default 5) + --viewMode string view mode for users (default "list") ``` ## Options inherited from parent commands diff --git a/www/docs/cli/filebrowser-config-set.md b/www/docs/cli/filebrowser-config-set.md index 8d8ea8f5..93515ab4 100644 --- a/www/docs/cli/filebrowser-config-set.md +++ b/www/docs/cli/filebrowser-config-set.md @@ -14,63 +14,60 @@ filebrowser config set [flags] ## Options ``` - --aceEditorTheme string ace editor's syntax highlighting theme for users - -a, --address string address to listen on (default "127.0.0.1") - --auth.command string command for auth.method=hook - --auth.header string HTTP header for auth.method=proxy - --auth.method string authentication type (default "json") - -b, --baseurl string base url - --branding.color string set the theme color - --branding.disableExternal disable external links such as GitHub links - --branding.disableUsedPercentage disable used disk percentage graph - --branding.files string path to directory with images and custom styles - --branding.name string replace 'File Browser' by this name - --branding.theme string set the theme - --cache-dir string file cache directory (disabled if empty) - -t, --cert string tls certificate - --commands strings a list of the commands a user can execute - --create-user-dir generate user's home directory automatically - --dateFormat use date format (true for absolute time, false for relative) - --dir-mode string mode bits that new directories are created with (default "0o750") - --disable-exec disables Command Runner feature (default true) - --disable-preview-resize disable resize of image previews - --disable-thumbnails disable image thumbnails - --disable-type-detection-by-header disables type detection by reading file headers - --file-mode string mode bits that new files are created with (default "0o640") - -h, --help help for set - --hide-login-button hide login button from public pages - --hideDotfiles hide dotfiles - --img-processors int image processors count (default 4) - -k, --key string tls key - --locale string locale for users (default "en") - --lockPassword lock password - -l, --log string log output (default "stdout") - --minimum-password-length uint minimum password length for new users (default 12) - --perm.admin admin perm for users - --perm.create create perm for users (default true) - --perm.delete delete perm for users (default true) - --perm.download download perm for users (default true) - --perm.execute execute perm for users (default true) - --perm.modify modify perm for users (default true) - --perm.rename rename perm for users (default true) - --perm.share share perm for users (default true) - -p, --port string port to listen on (default "8080") - --recaptcha.host string use another host for ReCAPTCHA. recaptcha.net might be useful in China (default "https://www.google.com") - --recaptcha.key string ReCaptcha site key - --recaptcha.secret string ReCaptcha secret - -r, --root string root to prepend to relative paths (default ".") - --scope string scope for users (default ".") - --shell string shell command to which other commands should be appended - -s, --signup allow users to signup - --singleClick use single clicks only - --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.by string sorting mode (name, size or modified) (default "name") - --token-expiration-time string user session timeout (default "2h") - --tus.chunkSize uint the tus chunk size (default 10485760) - --tus.retryCount uint16 the tus retry count (default 5) - --viewMode string view mode for users (default "list") + --aceEditorTheme string ace editor's syntax highlighting theme for users + -a, --address string address to listen on (default "127.0.0.1") + --auth.command string command for auth.method=hook + --auth.header string HTTP header for auth.method=proxy + --auth.method string authentication type (default "json") + -b, --baseURL string base url + --branding.color string set the theme color + --branding.disableExternal disable external links such as GitHub links + --branding.disableUsedPercentage disable used disk percentage graph + --branding.files string path to directory with images and custom styles + --branding.name string replace 'File Browser' by this name + --branding.theme string set the theme + -t, --cert string tls certificate + --commands strings a list of the commands a user can execute + --createUserDir generate user's home directory automatically + --dateFormat use date format (true for absolute time, false for relative) + --dirMode string mode bits that new directories are created with (default "0o750") + --disableExec disables Command Runner feature (default true) + --disablePreviewResize disable resize of image previews + --disableThumbnails disable image thumbnails + --disableTypeDetectionByHeader disables type detection by reading file headers + --fileMode string mode bits that new files are created with (default "0o640") + -h, --help help for set + --hideDotfiles hide dotfiles + --hideLoginButton hide login button from public pages + -k, --key string tls key + --locale string locale for users (default "en") + --lockPassword lock password + -l, --log string log output (default "stdout") + --minimumPasswordLength uint minimum password length for new users (default 12) + --perm.admin admin perm for users + --perm.create create perm for users (default true) + --perm.delete delete perm for users (default true) + --perm.download download perm for users (default true) + --perm.execute execute perm for users (default true) + --perm.modify modify perm for users (default true) + --perm.rename rename perm for users (default true) + --perm.share share perm for users (default true) + -p, --port string port to listen on (default "8080") + --recaptcha.host string use another host for ReCAPTCHA. recaptcha.net might be useful in China (default "https://www.google.com") + --recaptcha.key string ReCaptcha site key + --recaptcha.secret string ReCaptcha secret + -r, --root string root to prepend to relative paths (default ".") + --scope string scope for users (default ".") + --shell string shell command to which other commands should be appended + -s, --signup allow users to signup + --singleClick use single clicks only + --socket string socket to listen to (cannot be used with address, port, cert nor key flags) + --sorting.asc sorting by ascending order + --sorting.by string sorting mode (name, size or modified) (default "name") + --tokenExpirationTime string user session timeout (default "2h") + --tus.chunkSize uint the tus chunk size (default 10485760) + --tus.retryCount uint16 the tus retry count (default 5) + --viewMode string view mode for users (default "list") ``` ## Options inherited from parent commands diff --git a/www/docs/cli/filebrowser.md b/www/docs/cli/filebrowser.md index a8cbe669..8383ec97 100644 --- a/www/docs/cli/filebrowser.md +++ b/www/docs/cli/filebrowser.md @@ -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 by ourselves. -For this specific command, all the flags you have available (except -"config" for the configuration file), can be given either through -environment variables or configuration files. +For this command, all flags are available as environmental variables, +except for "--config", which specifies the configuration file to use. +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 -.filebrowser.{json, toml, yaml, yml} in the following directories: +If "--config" is not specified, File Browser will look for a configuration +file named .filebrowser.{json, toml, yaml, yml} in the following directories: - ./ - $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: -- flags -- environment variables -- configuration file -- database values -- 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. +- Flags +- Environment variables +- Configuration file +- Database values +- Defaults 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 @@ -47,28 +45,28 @@ filebrowser [flags] ## Options ``` - -a, --address string address to listen on (default "127.0.0.1") - -b, --baseurl string base url - --cache-dir string file cache directory (disabled if empty) - -t, --cert string tls certificate - -c, --config string config file path - -d, --database string database path (default "./filebrowser.db") - --disable-exec disables Command Runner feature (default true) - --disable-preview-resize disable resize of image previews - --disable-thumbnails disable image thumbnails - --disable-type-detection-by-header disables type detection by reading file headers - -h, --help help for filebrowser - --img-processors int image processors count (default 4) - -k, --key string tls key - -l, --log string log output (default "stdout") - --noauth use the noauth auther when using quick setup - --password string hashed password for the first user when using quick config - -p, --port string port to listen on (default "8080") - -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-perm uint32 unix socket file permissions (default 438) - --token-expiration-time string user session timeout (default "2h") - --username string username for the first user when using quick config (default "admin") + -a, --address string address to listen on (default "127.0.0.1") + -b, --baseURL string base url + --cacheDir string file cache directory (disabled if empty) + -t, --cert string tls certificate + -c, --config string config file path + -d, --database string database path (default "./filebrowser.db") + --disableExec disables Command Runner feature (default true) + --disablePreviewResize disable resize of image previews + --disableThumbnails disable image thumbnails + --disableTypeDetectionByHeader disables type detection by reading file headers + -h, --help help for filebrowser + --imageProcessors int image processors count (default 4) + -k, --key string tls key + -l, --log string log output (default "stdout") + --noauth use the noauth auther when using quick setup + --password string hashed password for the first user when using quick setup + -p, --port string port to listen on (default "8080") + -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) + --socketPerm uint32 unix socket file permissions (default 438) + --tokenExpirationTime string user session timeout (default "2h") + --username string username for the first user when using quick setup (default "admin") ``` ## See Also