Opengist

Opengist 是一个自托管的 Pastebin 工具，由 Git 驱动。所有代码片段都存储在 Git 仓库中，可通过标准 Git 命令或 Web 界面进行读取和/或修改。它类似于 https://gist.github.com/%EF%BC%8C%E4%BD%86%E5%BC%80%E6%BA%90%E4%B8%94%E5%8F%AF%E8%87%AA%E6%89%98%E7%AE%A1%E3%80%82

功能特性

• 创建公开、未列出或私有代码片段
• 通过 HTTP 或 SSH 经由 Git 初始化 / 克隆 / 拉取 / 推送代码片段
• 语法高亮；支持 Markdown 和 CSV
• 搜索代码片段中的代码；浏览用户的代码片段、点赞和分支
• 为代码片段添加主题标签
• 在其他网站中嵌入代码片段
• 修订历史记录
• 点赞 / 分支代码片段
• 下载原始文件或 ZIP 归档
• 支持通过 GitHub、GitLab、Gitea 和 OpenID Connect 进行 OAuth2 登录
• 限制或解除对***用户的代码片段可见性限制
• 支持 Docker / Helm Chart
• 更多...

快速开始

使用 Docker

每个版本均提供 Docker https://github.com/thomiceli/opengist/pkgs/container/opengist%EF%BC%9A

docker pull ghcr.io/thomiceli/opengist:1.12

可在 docker-compose.yml 文件中使用：

1. 创建包含以下内容的 docker-compose.yml 文件
2. 运行 docker compose up -d
3. Opengist 现已在端口 6157 上运行，可访问 http://localhost:6157

services:
  opengist:
    image: ghcr.io/thomiceli/opengist:1.12
    container_name: opengist
    restart: unless-stopped
    ports:
      - "6157:6157" # HTTP 端口
      - "2222:2222" # SSH 端口，如不使用 SSH 可移除
    volumes:
      - "$HOME/.opengist:/opengist"

可以通过设置 UID 和 GID 环境变量来定义运行容器并拥有文件的用户/组：

services:
  opengist:
    # ...
    environment:
      UID: 1001
      GID: 1001

通过二进制文件

从 https://github.com/thomiceli/opengist/releases/latest 的发布页面下载适用于您系统的归档文件并解压。

# 以 Linux amd64 为例
wget https://github.com/thomiceli/opengist/releases/download/v1.12.2/opengist1.12.2-linux-amd64.tar.gz

tar xzvf opengist1.12.2-linux-amd64.tar.gz
cd opengist
chmod +x opengist
./opengist # 可选择添加 `--config config.yml` 参数

Opengist 现已在端口 6157 上运行，可访问 http://localhost:6157

从源代码构建

git clone https://github.com/thomiceli/opengist
cd opengist
make
./opengist

Opengist 现已在端口 6157 上运行，可访问 http://localhost:6157

---

如需创建和运行开发环境，请参见 run-development.md。

文档

文档可在 [***] 或 /docs 目录中获取。

许可证

Opengist 采用 AGPL-3.0 许可证 授权。