svenstaro/miniserve

miniserve Docker镜像文档

镜像概述和主要用途

miniserve是一个轻量级、零配置的HTTP文件服务器，旨在快速提供文件共享服务。该Docker镜像封装了miniserve的核心功能，用户无需复杂配置，通过简单命令即可部署，实现文件的HTTP访问。主要用于临时文件共享、本地开发测试、局域网内快速文件传输等场景。

核心功能和特性

• 轻量级设计：体积小巧，资源占用低，启动速度快
• 零配置启动：无需预先编写配置文件，指定目录即可运行
• 丰富功能支持：
  • 目录浏览与文件下载
  • 支持gzip/brotli压缩传输
  • 基本HTTP认证保护
  • 隐藏文件控制与自定义主题
• 跨平台兼容：基于Docker容器，可在任何支持Docker的环境运行
• 灵活定制：支持自定义端口、访问路径、网页标题等参数

使用场景和适用范围

• 临时文件共享：快速向他人共享本地文件，无需搭建复杂服务器
• 本地开发测试：前端开发中预览静态资源或测试文件访问
• 局域网文件传输：在无专用文件共享服务的环境中，通过HTTP传输文件
• 轻量级服务部署：作为简单静态文件服务器，用于小型项目或演示环境

详细使用方法和配置说明

基本使用（Docker Run）

通过以下命令快速启动文件服务，共享本地目录：

bash
docker run -v /path/to/local/files:/data -p 8080:8080 svenstaro/miniserve /data

参数说明：

• -v /path/to/local/files:/data：将本地文件目录挂载到容器内/data目录
• -p 8080:8080：映射容器8080端口到主机8080端口
• /data：指定容器内需要提供服务的目录

启动后访问 http://localhost:8080 即可浏览和下载文件。

Docker Compose配置示例

创建 docker-compose.yml 文件实现持久化配置：

yaml
version: '3'
services:
  miniserve:
    image: svenstaro/miniserve
    volumes:
      - /path/to/local/files:/data
    ports:
      - "8080:8080"
    command: /data --title "My File Server" --gzip
    restart: unless-stopped

启动服务：docker-compose up -d

常用配置参数

高级使用示例

带认证和压缩的安全文件共享：

bash
docker run -v /secure/files:/data -p 8443:8080 svenstaro/miniserve /data \
  --auth "user:password123" \
  --gzip \
  --title "Secure File Share" \
  --readonly

注意事项

• 确保挂载目录具有适当权限，容器需要读取挂载文件
• 生产环境建议配合反向代理（如Nginx）使用，增加HTTPS支持
• 如需持久化配置，建议使用Docker Compose管理服务参数