thevickypedia/pyfilebrowser repository overview

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.

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

• 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⁠

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⁠

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

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