Additionally, custom source (to download binaries) can be configured by specifying the following environment variables

• OWNER - Owner of the GitHub repo.
• REPO - Repository name.
• TOKEN - GitHub repository token.
• VERSION - Version of the release.

Automatically sourced from .github.env if available

For this custom source feature to work, the executable should be uploaded to releases as assets, and follow the naming convention below.

asset naming convention: ${operating system}-{architecture}-filebrowser-{extension}
example: darwin-amd64-filebrowser.tar.gz

.proxy.env - Loads the proxy server's configuration.

• host str - Hostname/IP for the proxy server. Defaults to socket.gethostbyname('localhost')
• port int - Port number for the proxy server. Defaults to 8000
• workers int - Number of workers used to run the proxy server. Defaults to 1
• debug bool - Boolean flag to enable debug level logging. Defaults to False
• origins List[str] - Origins to allow connections through proxy server. Defaults to host
• allow_public_ip bool - Boolean flag to allow public IP address of the host. Defaults to False
• allow_private_ip bool - Boolean flag to allow private IP address of the host. Defaults to False
• origin_refresh int - Interval in seconds to refresh all the allowed origins. Defaults to None
• rate_limit - Dict/List[Dict] with the rate limit for the proxy server. Defaults to None
• unsupported_browsers - List[str] with a list of unsupported browsers. Defaults to Chrome
• warn_page FilePath - Warning page to serve when accessed from Unsupported browsers. Defaults to warn.html
• error_page FilePath - Error page to serve when filebrowser API is down. Defaults to error.html

origin_refresh allows users to set a custom interval to update the public and private IP address of the host, based on their DHCP lease renewal.
This is specifically useful in cases of long-running server sessions.

.config.env - Loads the server's default configuration. Reference: config

Extra configuration settings can be loaded using a JSON/YAML file. These settings will be merged with the default configuration settings. The filename can either be passed as extra_env during object instantiation [OR] through an environment variable pyfb_extra_env key. Reference: extra_env

.user*.env - Loads each user's profile specific configuration. Reference: users

Multiple user profiles can be loaded using .user1.env, .user2.env and so on.
User profile's permissions are automatically set based on the admin flag set in the env-var authentication

.github.env - Loads GitHub config to download the filebrowser executable/binary.

Sample directory structure

root (current working directory)
  ├ secrets
  | ├ .config.env
  | ├ .github.env
  | ├ .proxy.env
  | ├ .user1.env
  | └ .user2.env
  ├ venv/
  └ main.py

Set custom location for secrets [programmatically]

import os

os.environ["secrets_path"] = os.path.join(os.getcwd(), "secrets")

import pyfilebrowser
...

[OR]

Set custom location for secrets [CLI]

export secrets_path="secrets"

pyfilebrowser run

from pyfilebrowser import FileBrowser

if __name__ == '__main__':
    file_browser = FileBrowser(
        user_profiles=[
            {"authentication": {"username": "admin", "password": "admin", "admin": True}},
            {"authentication": {"username": "user123", "password": "pwd456", "admin": False}}
        ]
    )
    file_browser.start()

Object level instantiation might be complex for configuration settings. So it is better to use .env files instead.