Metadata
Files and folders can be enhanced with custom metadata to provide additional context, labels, or visibility controls. Metadata is defined in a JSON file named .dbmeta.json (for files) or .dbmeta.json (for folders), located in the same directory as the target item.
Themes
Choose from a variety of themes to customize the look and feel of your directory browser. All themes support light and dark mode.
Password Protection
Folders can be protected with a password using a .access.json file.
Download Counter
Download count tracks the number of times a file has been downloaded/visited/opened. It will be saved in a persistent redis database (-v redissave:/var/lib/redis/).
Date & Time
Controls how file and folder timestamps are displayed in the file list.
Search & Sorting
image
Readme Rendering
If there is a readme.md (case insensitive) (can be configured) file in the current directory, it will be rendered. GitHub flavored markdown is supported. See Demo Page.
Hide Files & Folders
In contrast to using metadata the file or folder is completely hidden/ignored from the filetree, all APIs and cannot be accessed via URL.
Batch Downloads
The batch download feature allows you to download multiple files at once in a zip file.
CORS
CORS (Cross-Origin Resource Sharing) is a security feature implemented by web browsers that allows or restricts web applications running at one origin to make requests to resources from another origin.
Integrity & Hashes
It is possible to verify the integrity of a file by setting the ?hash query parameter to the hash of the file. If the hash does not match the actual hash of the file, an error will be returned instead.
API Reference
dir-browser provides a lightweight HTTP API that allows you to retrieve directory listings and file metadata in JSON format. These endpoints are useful for building custom frontends or integrating with other services.
File Icons
Display file and folders icons in the file tree. Increases the css bundle.
Custom JavaScript
||" values="||" versions="3.3|3.3|3.3" desc="JS code. Will be executed on every page navigated.|URL to JS file. Will be executed on every page navigated.|URL to JS file. Will be executed only once on first visit. Subsequent navigation will not execute it again."/>
Layout
LAYOUT
Pagination
Display a large number of items in a list by splitting them into multiple pages.
Prefetching on Hover
By default, hovering over a folder link in the filetree will prefetch the contents of the folder. This can be disabled by setting the PREFETCH_FOLDERS environment variable to false.
Timing
Display the time it took to generate the page. This is useful for debugging and performance tuning.