svenstaro/miniserve
Miniserve
Miniserve is an HTTP static file server that hosts local directories over the network with an integrated web-based file browser. It functions as a single-binary tool capable of serving as a markdown rendering server, a TLS-enabled web server for encrypted traffic, and a WebDAV file manager for remote file operations.
The project distinguishes itself through specialized hosting modes, including a single page application mode that routes requests to a single index file and the ability to generate random hexadecimal access URLs to obscure served directories. It also provides the ability to convert markdown files into formatted HTML and generate QR codes for simplified mobile device connectivity.
The server includes capabilities for file management such as uploads, directory archiving into zip or tar formats, and file listing filtration. Security and network control are handled through password authentication, TLS encryption, and the injection of custom HTTP response headers.
The tool supports deployment via containerized images and allows for specific network interface binding.
Features
- Static File Servers - Provides a lightweight server for hosting local directories and static files over HTTP.
- Static Web Hosting - Functions as a single-binary server that hosts local files and directories over HTTP.
- HTTP Servers - Provides a high-performance HTTP server for hosting local files and directories.
- Markdown Renderers - Automatically transforms markdown files into formatted HTML pages for readable web documentation.
- WebDAV Remote File Management - Integrates the WebDAV protocol to enable remote file uploading, deleting, and renaming.
- Transport Layer Security - Secures file transfers by providing an encrypted HTTPS interface using TLS certificates.
- Directory Archiving - Bundles directories into zip or tar archives using streaming to handle large datasets.
- Markdown to HTML Converters - Transforms markdown files into formatted HTML pages for a readable web-based documentation experience.
- Temporary Sharing - Facilitates fast device-to-device transfers using temporary HTTP links and QR codes.
- Obscured Access URLs - Generates random hexadecimal routes to obscure the paths to served directories.
- Password Access Restrictions - Restricts access to documents through password authentication and TLS encryption to ensure privacy.
- Credential-Based Access Controls - Implements credential-based access control using usernames and passwords to protect served folders.
- Password Authentication - Implements username and password validation to restrict access to served folders.
- Transport Layer Encryption - Secures network traffic between clients and the server using TLS and HSTS certificates.
- File Upload Management - Enables the transfer of files and directories to the server with configurable path restrictions.
- Request Routing - Directs incoming requests to specific local directories based on URI path prefixes or random strings.
- Single Page Application Hosting - Implements fallback routing that directs all network requests to a single index file for client-side navigation.
- File Management - Listed in the “File Management” section of the Awesome Selfhosted awesome list.
- Web Servers & Proxies - Self-contained CLI tool for serving files.
- Web File Managers - CLI tool for serving files and directories over HTTP.
- Web Services - CLI tool for serving files via HTTP.
