evanpurkhiser/waitress

Waitress Docker镜像文档

镜像概述与主要用途

Waitress 是一款轻量级文件服务器，旨在快速、美观地提供文件服务。它设计简洁，部署便捷，适用于需要临时或简单文件共享的场景，可通过 Docker 容器快速启动，实现本地文件的 HTTP 访问。

核心功能与特性

当前功能

• 轻量级部署：作为小型服务器，资源占用低，启动速度快
• 简单配置：通过文件挂载即可指定服务根目录，无需复杂配置
• 基础文件服务：支持目录浏览与文件下载（基于文件服务器基本功能推断）

计划功能（即将推出）

• 客户端搜索功能
• 插件系统支持
• 目录打包下载插件（ZIP 格式）
• 视频转码插件（支持 Chromecast）

使用场景与适用范围

• 本地文件共享：快速共享主机目录下的文件（如文档、媒体文件）
• 开发环境资源服务：为前端/后端开发提供静态资源（如 JS、CSS、图片）
• 临时文件分发：小团队内部临时共享文件，无需搭建复杂服务器

使用方法与配置说明

前提条件

• 已安装 Docker 引擎（Docker 安装指南）

基本部署（docker run 命令）

通过 Docker 快速启动服务，将主机目录挂载到容器内作为文件服务根目录：

bash
# 将主机当前目录（$PWD）作为服务根目录，映射容器 80 端口到主机 8000 端口
docker run -p 8000:80 -v $PWD:/data evanpurkhiser/waitress

参数说明：

• -p 8000:80：端口映射，容器内服务默认监听 80 端口，主机通过 http://localhost:8000 访问
• -v $PWD:/data：数据卷挂载，将主机目录（如 $PWD）挂载到容器 /data 目录（服务根目录）

自定义配置

1. 修改服务端口

如需使用主机其他端口（如 8888），调整 -p 参数：

bash
# 主机端口改为 8888，容器端口保持 80
docker run -p 8888:80 -v /path/to/your/files:/data evanpurkhiser/waitress

2. 指定自定义目录

如需服务非当前目录的文件，替换 -v 参数中的主机目录路径：

bash
# 服务主机 /home/user/documents 目录下的文件
docker run -p 8000:80 -v /home/user/documents:/data evanpurkhiser/waitress

Docker Compose 配置示例

创建 docker-compose.yml 文件，定义服务配置：

yaml
version: '3'
services:
  waitress:
    image: evanpurkhiser/waitress
    ports:
      - "8000:80"  # 主机端口:容器端口
    volumes:
      - ./files:/data  # 主机目录（./files）挂载到容器 /data
    restart: unless-stopped  # 容器退出时自动重启（可选）

启动服务：

bash
docker-compose up -d

访问服务

服务启动后，通过浏览器或 HTTP 客户端访问 http://<主机IP>:<映射端口>（如 http://localhost:8000），即可浏览挂载目录下的文件并下载。

其他说明

• 本地构建（可选）：若需从源码构建二进制文件，可执行以下命令（非 Docker 部署方式）：

  bash
  make
  dist/waitress -root $PWD  # 指定服务根目录