dir-browser Documentation

Directory v2 is a lightweight, secure file server with a low memory footprint (~10MB). Key capabilities include:

• Performance & Compatibility: Fast file serving via nginx, arm64 support, and functionality without JavaScript enabled.
• File Management: Download counts for all files, password protection, and custom descriptions/labels for files and folders.
• UI/UX: Responsive design for mobile and desktop, Light and Darkmode, multiple themes, file icons, and README markdown rendering.
• Technical Specs: Clean URLs mapping to file system paths, file statistics (modification dates/sizes), and highlighting of recently updated files.
• Deployment: Easy setup via a single Docker image and configuration through environment variables.

Directory v4 is a lightweight file server (approx. 10MB memory footprint) designed for fast file serving via nginx. Key capabilities include:

• File Management: Batch downloads (zip), file integrity hashes, custom descriptions/labels, and the ability to hide files/folders.
• Access & Security: Secure read-only access by default, password protection, and clean URLs matching file system paths.
• UI/UX: Responsive design, light/dark modes, multiple themes, file icons, and built-in search and sorting.
• Developer Tools: JSON API for programmatic access, README markdown rendering, and support for custom JS/CSS.
• Deployment: Single Docker image setup with arm64 support and configuration via environment variables.

The Directory Browser (v0) is a lightweight, secure, read-only file serving tool designed for high performance and low resource usage. Key features include:

• Performance: Extremely fast file serving powered by nginx with a low memory footprint (~10MB).
• Deployment: Easy setup using a single Docker image with arm64 support.
• File Management: Tracks download counts for all files and provides file statistics including modification dates, sizes, and hashes.
• UI/UX: Responsive design for mobile and desktop with support for both Light and Dark modes.

Directory v3 is a fast, low-memory (~10MB) file serving solution deployed via a single Docker image. It is designed to be secure by default with read-only access and supports arm64 architecture. Key capabilities include:

• File Management: Batch downloads (ZIP), file integrity hashes, custom descriptions/labels, and the ability to hide files/folders.
• Performance & Access: Fast serving via nginx, clean URLs mapping to file system paths, and a JSON API for programmatic access.
• User Interface: Responsive design with Light/Dark mode, multiple themes, file icons, and built-in search/sorting. It remains functional even without JavaScript enabled.
• Configuration: Easily configured using environment variables with support for custom JS and CSS.
• Additional Tools: Download counters, README markdown rendering, password protection, and request timing tracking.

Directory (dir) v1 is a lightweight, secure file-serving application designed for high performance and low resource consumption. Key features include:

• Performance: Fast file serving via nginx with a low memory footprint (~10MB).
• Security: Read-only access by default.
• File Management: Tracks download counts and provides file statistics including modification dates, sizes, and hashes.
• UI/UX: Responsive design for mobile and desktop, support for Light and Dark modes, multiple available themes, and README markdown rendering.
• Deployment: Easy setup via a single Docker image with arm64 support and configuration managed through environment variables.