ardoin/pasteserver

PasteServer镜像说明

镜像概述

PasteServer是一个轻量级服务，用于快速上传和管理文本或代码片段。支持多种存储后端（文件系统、Redis、ArangoDB），并提供完整的API接口，方便集成到各类工作流中。

核心功能

• 支持文本/代码片段的上传、读取和删除
• 多存储方式：文件系统、Redis、ArangoDB
• 可配置速率限制，防止***请求
• 自定义文档过期时间（Redis存储支持）
• 灵活的文档密钥生成规则

使用场景

• 团队内部快速共享代码片段或配置文件
• 临时存储文本内容，方便跨设备访问
• 作为后端服务，为前端应用提供文本存储能力

部署示例

1. 文件存储方式

yml
version: "3"
services:
  pasteserver:
    image: einsarsum/pasteserver
    ports:
      - 5000:5000

2. Redis存储方式

yml
version: "3"
services:
  pasteserver:
    image: einsarsum/pasteserver
    ports:
      - 5000:5000
    depends_on:
      - database
    environment:
      - STORAGE_TYPE=redis
      - STORAGE_HOST=database
      - STORAGE_PASSWORD=password

  database:
    image: redis:alpine
    entrypoint: redis-server --appendonly yes --requirepass password

3. ArangoDB存储方式

yml
version: "3"
services:
  pasteserver:
    image: einsarsum/pasteserver
    ports:
      - 5000:5000
    depends_on:
      - database
    environment:
      - STORAGE_TYPE=arango
      - STORAGE_HOST=database
      - STORAGE_PORT=8529
      - STORAGE_PASSWORD=password
      - STORAGE_DATABASE=pasteServer

  database:
    image: arangodb
    environment:
      - ARANGO_ROOT_PASSWORD=password

配置说明

通过环境变量可配置服务的各项参数：

Server部分

• PORT: 服务运行的端口（默认5000）

存储部分

• STORAGE_TYPE: 存储类型（可选值：file/redis/arangodb）
• STORAGE_HOST: 存储服务的主机地址
• STORAGE_PORT: 存储服务的端口
• STORAGE_PASSWORD: 存储服务的密码
• STORAGE_USER: 存储服务的用户名（仅ArangoDB）
• STORAGE_DATABASE: 存储使用的数据库名（仅ArangoDB）
• DOCUMENT_EXPIRE: 文档过期时间（毫秒，仅Redis）
• STORAGE_PATH: 文件存储的路径（仅file存储）

速率限制部分

• CREATE_RATE_LIMIT_TIME_IN_MS: 创建文档的速率限制时间窗口（毫秒）
• CREATE_RATE_LIMIT_MAX_REQUESTS_PER_TIME: 每个IP在时间窗口内允许的最大创建请求数

文档部分

• DOCUMENT_DATA_LIMIT: 创建请求的最大数据大小
• DOCUMENT_MAX_LENGTH: 文档允许的最大字符数

密钥生成部分

• KEY_GENERATOR_KEY_LENGTH: 文档密钥的长度
• KEY_GENERATOR_KEY_CHARS: 生成密钥使用的字符集
• KEY_GENERATOR_WITH_TO_UPPER_CASE: 是否将字符集转换为大写并添加（布尔值）

API接口说明

所有API请求均指向/documents路由（例如：http://localhost:5000/documents）。

创建文档

• 请求方法: POST
• 请求体: 待上传的文本（纯文本格式）
• 成功响应:
  • 状态码：201 Created
  • 响应体：{"key": "文档密钥", "deleteSecret": "删除密钥"}
• 错误响应:
  • 400 Bad Request（缺少文本）
  • 413 Payload Too Large（文本过长）
  • 500 Internal Server Error（存储失败）
  • 响应体：{"message": "错误描述"}

读取文档

• 请求方法: GET
• 请求路径: /documents/{key}（替换{key}为文档密钥）
• 成功响应:
  • 状态码：200 OK
  • 响应体：{"text": "文档内容"}
• 错误响应:
  • 404 Not Found（文档不存在）
  • 响应体：{"message": "错误描述"}

删除文档

• 请求方法: GET
• 请求路径: /documents/delete/{key}/{deleteSecret}（替换{key}和{deleteSecret}）
• 成功响应:
  • 状态码：200 OK
  • 响应体：{"message": "删除成功"}
• 错误响应:
  • 400 Bad Request（缺少删除密钥）
  • 403 Forbidden（密钥错误）
  • 响应体：{"message": "错误描述"}

速率限制

当请求超过速率限制时，返回：

• 状态码：429 Too Many Requests
• 响应体：{"message": "请求过于频繁，请稍后再试"}