halverneus/static-file-server

static-file-server

镜像概述

static-file-server 是一个轻量级、简单的静态文件服务器，通过环境变量进行配置。可从以下位置获取：

• Docker Hub: https://hub.docker.com/r/halverneus/static-file-server/
• GitHub: https://github.com/halverneus/static-file-server

核心功能和特性

• 灵活配置：支持通过环境变量或 YAML 配置文件进行参数设置
• CORS 支持：可配置跨域资源共享
• 调试模式：提供详细的运行时调试信息
• 目录列表：自动为目录提供索引文件列表（可禁用）
• URL 前缀：支持设置 URL 路径前缀
• TLS 加密：支持 HTTPS 协议，可配置最小 TLS 版本
• 引用者限制：限制允许访问的 HTTP 引用者来源

使用场景和适用范围

• 本地开发环境静态文件服务
• 小型静态网站部署
• 测试环境文件共享服务
• 需要快速搭建的轻量级文件服务器

配置说明

环境变量配置

以下是支持的环境变量及其默认值：

bash
# 允许跨域资源访问，设置为true时允许任何域访问
CORS=false

# 启用调试模式，打印额外执行信息。注意：配置摘要输出到stdout，运行日志输出到stderr
DEBUG=false

# 绑定的主机名，留空则接受指定端口上的所有HTTP请求
HOST=

# 服务端口，必须是有效的端口号
PORT=8080

# 是否自动为目录提供索引文件列表，设为false时以"/"结尾的URL将返回"NOT FOUND"
SHOW_LISTING=true

# 要提供服务的文件目录
FOLDER=/web

# URL路径前缀，例如若URL_PREFIX为"/my/place"，则根目录下的"my.file"可通过"http://$HOST:$PORT/my/place/my.file"访问
URL_PREFIX=

# TLS证书和密钥路径，两者必须同时设置才能启用HTTPS，否则使用HTTP
TLS_CERT=
TLS_KEY=

# 最小TLS版本，仅在设置TLS证书和密钥时有效。可选值："TLS10"、"TLS11"、"TLS12"、"TLS13"（不区分大小写），默认1.0
TLS_MIN_VERS=

# 允许的HTTP引用者列表，若HTTP请求头"Referer"不匹配列表中的前缀则返回403。示例：
# REFERRERS=http://localhost,https://example.com
# 要允许缺少Referer头，可添加空条目（以逗号开头）：REFERRERS=,http://localhost
REFERRERS=

YAML配置文件

YAML配置项可被对应的环境变量覆盖。通过命令行选项（-c, -config, --config）指定配置文件路径。

默认配置示例：

yaml
cors: false
debug: false
folder: /web
host: ""
port: 8080
referrers: []
show-listing: true
tls-cert: ""
tls-key: ""
tls-min-vers: ""
url-prefix: ""

自定义配置示例：

yaml
debug: true
folder: /var/www
port: 80
referrers:
    - http://localhost
    - https://mydomain.com

部署方法

非Docker方式

bash
PORT=8888 FOLDER=. ./serve

文件可通过 http://localhost:8888/my/file.txt 访问

Docker方式

基本部署：

bash
docker run -d \
    -v /my/folder:/web \
    -p 8080:8080 \
    halverneus/static-file-server:latest

此命令将"/my/folder"目录通过 http://localhost:8080/my/file.txt 提供服务

自定义配置示例：

bash
docker run -d \
    -v /home/me/dev/source:/content/html \
    -v /home/me/dev/files:/content/more/files \
    -e FOLDER=/content \
    -e PORT=80 \
    -e SHOW_LISTING=false \
    -p 80:80 \
    halverneus/static-file-server:latest

获取帮助

bash
# 本地运行
./serve help

# Docker方式
docker run -it halverneus/static-file-server:latest help