Skip to content

lockcp/litepastebin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LitePastebin

Language Docker

LitePastebin 是一个极其轻量、专注体验的个人自建文本分享服务(Pastebin)。它采用了全屏编辑器的设计理念,支持 Markdown 渲染、代码高亮、密码保护及 PWA,旨在为您提供类似于“私有化 Gist”的极速分享体验。


✨ 核心特性

  • 🚀 极速分享:打开即是全屏编辑器,写完即发。
  • 📝 多格式支持:内置 Markdown 渲染与 100+ 种语言的代码高亮(Highlight.js)。
  • 🔒 隐私安全:支持为分享设置访问密码,支持设置过期时间,支持自定义 Slug。
  • 📱 PWA 支持:可作为独立 App 安装至手机或电脑,沉浸式使用体验。
  • 🛠️ 开发者友好:支持 /:slug/raw 原始文本获取,方便 curl 或脚本调用。
  • 🌓 自动主题:完美适配深色/浅色模式。
  • ⌨️ 快捷键支持:编辑器内置查找、替换等高效操作指令。

⌨️ 编辑器快捷键

当输入类型选择为 Code 时,可在编辑器内使用以下快捷键提高效率:

快捷键 功能
Ctrl+F / Cmd+F 查找
Ctrl+G / Cmd+G 查找下一个
Shift+Ctrl+G / Shift+Cmd+G 查找上一个
Ctrl+Shift+F / Cmd+Option+F 查找并替换
Ctrl+Shift+R 全部替换
Alt+G 跳转到指定行号

🚀 快速开始

方式一:使用 Docker (推荐)

这是最简单、最干净的安装方式。

  1. 方式 A:使用 Docker Compose (推荐)

    docker-compose up -d
  2. 方式 B:使用 Docker CLI

    docker run -d \
      --name litepastebin \
      -p 3382:3382 \
      -v $(pwd)/data:/app/data \
      -e ADMIN_USERNAME=admin \
      -e ADMIN_PASSWORD=您的密码 \
      -e API_KEY=您的API密钥 \
      lockcp/litepastebin
  3. 访问与日志

    • 访问地址:http://localhost:3382
    • 默认账号:admin
    • 默认密码:admin888

    💡 提示:如果您没有在环境变量中设置 API_KEY,系统在启动时会随机生成一个。您可以通过查看容器日志来获取当前的登录凭据和 API Key:

    # 查看 Docker 容器日志
    docker logs litepastebin

方式二:使用 Node.js 直接运行

确保您的 Node.js 版本 >= 22.0.0。

# 启动服务器
npm start

⚙️ 环境变量配置

您可以通过 docker-compose.yml 或环境变量修改以下配置:

变量名 说明 默认值
PORT 服务监听端口 3382
ADMIN_USERNAME 管理员用户名 admin
ADMIN_PASSWORD 管理员登录密码 admin888
API_KEY 程序化调用 API 所需的密钥 secret-key-123

🔌 API 接口

LitePastebin 提供了简单的管理接口,支持使用 X-API-Key 请求头进行鉴权:

  • POST /api/v1/admin/text/generate - 生成新文本分享
  • GET /api/v1/admin/shares - 获取所有链接列表
  • PUT /api/v1/admin/shares/:slug - 修改分享属性
  • DELETE /api/v1/admin/shares - 批量删除分享

📂 项目结构

  • /admin - 前端静态资源 (HTML/CSS/JS)
  • /src - 后端逻辑 (Node.js 22 Native)
  • /data - 自动生成的数据库与文本存储目录
  • docker-compose.yml - 容器化部署方案

📄 开源协议

本项目基于 CC BY-NC-SA 4.0 (署名-非商业性使用-相同方式共享) 协议开源。

  • 署名:您必须给出适当的署名,提供指向本许可协议的链接。
  • 非商业性使用:您不得将本作品用于商业目的。
  • 相同方式共享:如果您再混合、转换、或者基于该作品进行创作,您必须基于与原先许可协议相同的许可协议分发您贡献的作品。

About

LitePastebin 是一个极其轻量、专注体验的个人自建文本分享服务(Pastebin)。它采用了全屏编辑器的设计理念,支持 Markdown 渲染、代码高亮、密码保护及 PWA,旨在为您提供类似于“私有化 Gist”的极速分享体验。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors