ghcr.io/thomiceli/opengist:1.10.0

Opengist

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

功能特性

• 创建公开、未列出或私有代码片段
• 通过 HTTP 或 SSH 协议，使用 Git 初始化（Init）/ 克隆 / 拉取 / 推送代码片段
• 语法高亮；支持 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.13

可通过 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.13
    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.13.1/opengist1.13.1-linux-amd64.tar.gz

tar xzvf opengist1.13.1-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 许可证。