einsarsum/pasteserver

PasteServer

这是Panamo的PasteServer的Docker镜像，用于快速部署文本/代码片段上传与管理服务，支持多种存储后端，并提供API接口实现文档的创建、读取和删除操作。

核心功能

• 支持文件存储、Redis、ArangoDB三种存储方式
• 提供RESTful API实现文档的创建、读取、删除
• 可配置速率限制防止请求
• 支持文档过期时间设置（Redis/ArangoDB存储方式）
• 可自定义文档密钥生成规则（长度、字符集等）

使用场景

• 团队内部快速共享代码片段或文本内容
• 临时保存需要分享的文本信息
• 搭建个人或小型团队的私有paste服务

配置说明

通过Docker环境变量进行配置，主要分为以下几个部分：

Server-section（服务器配置）

• PORT: 服务器运行的端口

Storage-section（存储配置）

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

RateLimit-section（速率限制配置）

• CREATE_RATE_LIMIT_TIME_IN_MS: 每个IP在指定时间内允许的请求次数的时间窗口（毫秒）
• CREATE_RATE_LIMIT_MAX_REQUESTS_PER_TIME: 每个IP在时间窗口内允许的最大请求次数

Document-section（文档配置）

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

KeyGenerator-section（密钥生成配置）

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

Docker部署示例

使用文件存储

yml
version: "3"

services:
  pasteserver:
    image: einsarsum/pasteserver
    ports:
      - 5000:5000

使用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

使用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_USER=pasteServer
      - STORAGE_PASSWORD=password
      - STORAGE_DATABASE=pasteServer

  database:
    image: arangodb
    environment:
      - ARANGO_ROOT_PASSWORD=password

API接口说明

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

创建文档

发送POST请求，请求体为纯文本内容。

• 成功响应：状态码201，返回包含key（文档密钥）和deleteSecret（删除密钥）的JSON
• 缺失文本：状态码400，返回包含message的JSON
• 文本过长：状态码413，返回包含message的JSON
• 存储错误：状态码500，返回包含message的JSON

读取文档

发送GET请求到/documents/$key（$key为文档密钥）。

• 存在文档：状态码200，返回包含text的JSON
• 不存在文档：状态码404，返回包含message的JSON

删除文档

发送GET请求到/documents/delete/$key/$deleteSecret（$key为文档密钥，$deleteSecret为删除密钥）。

• 成功删除：状态码200，返回包含message的JSON
• 缺失删除密钥：状态码400，返回包含message的JSON
• 密钥错误：状态码403，返回包含message的JSON

速率限制

创建和删除文档有速率限制，超过限制时返回：

• 状态码429，返回包含message的JSON