orhunp/rustypaste

rustypaste Docker镜像文档

镜像概述

rustypaste Docker镜像是基于Rust编写的轻量级自托管文件共享服务的容器化封装。该服务旨在提供简单、高效的文件分享解决方案，支持多种灵活的分享策略，无需复杂的基础设施，即可快速搭建个人或团队级文件分享平台。镜像体积小巧，运行资源占用低，适合个人用户、小型团队或需要临时文件传输功能的场景。

核心功能与特性

• 轻量级设计：基于Rust编译的二进制文件，体积小、启动快，运行时内存占用低（通常<10MB）。
• 灵活分享选项：
  • 一次性链接：文件被下载后自动删除，防止重复访问
  • 文件过期控制：支持自定义文件存活时间（如10分钟、1小时、1天）
  • 密码保护：可为分享文件设置访问密码，增强安全性
• 简单配置：支持通过环境变量或配置文件自定义服务参数，无需复杂的依赖配置。
• 无数据库依赖：文件元数据直接存储在本地文件系统，简化部署流程。
• 多平台支持：兼容Linux/amd64、Linux/arm64等主流容器架构。
• 命令行与Web双界面：支持通过Web界面上传文件，也可通过curl等工具直接调用API上传。

使用场景与适用范围

• 个人文件临时分享：快速向他人发送临时文件，无需依赖第三方平台（如网盘）。
• 团队内部协作：团队成员间传输开发素材、测试数据等非敏感文件，支持过期自动清理。
• 公共文件分发：搭建小型公共文件下载服务，通过一次性链接控制访问次数。
• 低资源环境部署：适用于树莓派、NAS等边缘设备，或资源受限的服务器环境。

使用方法与配置说明

基本部署（Docker Run）

通过以下命令快速启动基础服务：

bash
docker run -d \
  --name rustypaste \
  -p 8000:8000 \
  -v ./rustypaste-data:/app/data \
  orhunp/rustypaste:latest

参数说明：

• -p 8000:8000：将容器内8000端口映射到主机8000端口，用于访问服务
• -v ./rustypaste-data:/app/data：挂载主机目录到容器内数据目录，实现文件持久化存储

环境变量配置

通过环境变量自定义服务行为，常用参数如下：

示例：启用密码保护并设置默认过期时间为1小时

bash
docker run -d \
  --name rustypaste \
  -p 8000:8000 \
  -v ./rustypaste-data:/app/data \
  -e RUSTYPASTE_EXPIRY=1h \
  -e RUSTYPASTE_AUTH=admin:SecurePass123 \
  orhunp/rustypaste:latest

高级配置（使用配置文件）

如需更复杂的配置（如自定义URL路径、限制文件大小等），可通过挂载配置文件实现。创建config.toml配置文件，示例内容：

toml
[server]
addr = "0.0.0.0:8080"  # 自定义端口
upload_dir = "/app/data/uploads"

[paste]
secret = "your_secure_secret_key_here"  # 自定义密钥
expiry = "2h"  # 默认过期时间2小时
onetime = false  # 全局禁用一次性链接
max_size = 10  # 最大文件大小（单位：MB）

[auth]
enabled = true
username = "team_user"
password = "team_password_123"

启动容器时挂载配置文件：

bash
docker run -d \
  --name rustypaste \
  -p 8080:8080 \
  -v ./rustypaste-data:/app/data \
  -v ./config.toml:/app/config.toml \
  orhunp/rustypaste:latest --config /app/config.toml

服务访问与使用

Web界面访问

启动后通过 http://<主机IP>:8000 访问Web界面，直接拖拽文件至页面即可上传，上传后自动生成分享链接。

命令行上传

通过curl命令上传文件（适用于无Web界面的环境）：

bash
# 基础上传（无密码/过期设置）
curl -F "file=@/path/to/local/file.txt" http://<主机IP>:8000

# 带过期时间上传（覆盖默认设置，如10分钟）
curl -F "file=@/path/to/file.zip" -H "Expiry: 10m" http://<主机IP>:8000

# 带密码上传
curl -F "file=@/path/to/doc.pdf" -F "password=share123" http://<主机IP>:8000

注意事项

• 数据持久化：必须挂载数据卷（如示例中的./rustypaste-data），否则容器重启后上传的文件将丢失。
• 安全性增强：生产环境中需设置自定义RUSTYPASTE_SECRET并启用AUTH认证，避免未授权访问；建议配合反向代理（如Nginx）配置HTTPS。
• 资源限制：通过max_size配置限制单文件大小，避免磁盘空间过度占用。
• 日志查看：通过docker logs rustypaste查看服务运行日志，排查上传/访问异常。