serversideup/github-cli

serversideup/github-cli Docker镜像文档

概述

serversideup/github-cli 是一个通过Docker运行GitHub CLI的轻量级解决方案，支持多操作系统、自定义用户配置及多架构部署，为开发者提供灵活便捷的GitHub命令行工具运行环境。

核心功能和特性

• 🐧 Debian 和 Alpine - 提供两种操作系统选择
• 🔒 非特权用户 - 可选择以root或非特权用户身份运行
• 📌 固定GitHub CLI版本 - 支持精确到补丁版本的版本控制
• 🔧 自定义运行用户 - 可自定义运行用户名
• 🔑 自定义PUID和PGID - 支持与主机用户ID和组ID匹配
• 📦 多镜像仓库支持 - 可从Docker Hub或GitHub Container Registry拉取镜像
• 🤖 多架构支持 - 每个镜像均支持x86_64和arm64架构

使用场景和适用范围

适用于需要在不同环境中统一运行GitHub CLI的开发场景，尤其适合CI/CD流水线、开发环境标准化、多用户共享环境以及需要精确控制用户权限的场景。

使用方法和配置说明

选择镜像仓库

镜像可从Docker Hub和GitHub Container Registry获取：

DockerHub:

• https://hub.docker.com/r/serversideup/github-cli

GitHub Container Registry:

• https://github.com/serversideup/docker-github-cli/pkgs/container/github-cli

挂载目录

挂载/config目录

为实现GitHub认证，需将主机的~/.config目录挂载到容器的/config目录。该目录通过符号链接关联到非特权用户的主目录，确保即使更改RUN_AS_USER环境变量，仍能保持配置路径的一致性。例如，若将RUN_AS_USER设为bob，则/home/bob/.config会符号链接到/config。

挂载/app目录

/app目录用于挂载工作空间，建议将当前项目目录挂载至此。

SSH配置

SSH相关文件通过/ssh目录管理，该目录会符号链接到用户主目录下的.ssh文件夹，确保SSH配置在不同用户身份下的一致性。

更改运行用户、PUID和PGID

bash
docker run --rm -it \
  -v "$HOME/.ssh:/ssh:ro" \
  -v "$HOME/.ssh/known_hosts:/ssh/known_hosts:rw" \
  -v "$(pwd):/app" \
  -v "$HOME/.config/gh:/config/gh:rw" \
  -e "PUID=9999" \
  -e "PGID=9999" \
  -e "RUN_AS_USER=bob" \
  serversideup/github-cli:latest gh --version

运行shell

bash
docker run --rm -it \
  -v "$HOME/.ssh:/ssh" \
  -v "$(pwd):/app" \
  serversideup/github-cli:latest /bin/sh

SSH配置说明

注意：SSH密钥配置可能较为复杂，尤其是动态设置RUN_AS_USER时。以下方法可简化配置过程：

/ssh目录

默认情况下，/ssh目录会符号链接到~/.ssh，作为SSH密钥和配置的统一管理目录。设置RUN_AS_USER后，容器会自动在/home/${RUN_AS_USER}创建主目录，并将/home/${RUN_AS_USER}/.ssh符号链接到/ssh。

挂载SSH认证套接字

SSH认证套接字是SSH代理用于进程间通信的Unix套接字，需按以下方式挂载：

macOS:

bash
docker run --rm -it \
  -v "$HOME/.ssh:/ssh:ro" \
  -v "$HOME/.ssh/known_hosts:/ssh/known_hosts:rw" \
  -v "$(pwd):/app" \
  -v "/run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock" \
  -e SSH_AUTH_SOCK="/run/host-services/ssh-auth.sock" \
  serversideup/github-cli:latest gh --version

Linux:

bash
docker run --rm -it \
  -v "$HOME/.ssh:/ssh:ro" \
  -v "$HOME/.ssh/known_hosts:/ssh/known_hosts:rw" \
  -v "$(pwd):/app" \
  -v "$SSH_AUTH_SOCK:$SSH_AUTH_SOCK" \
  -e SSH_AUTH_SOCK="$SSH_AUTH_SOCK" \
  serversideup/github-cli:latest gh --version

环境变量

可通过以下环境变量自定义镜像行为：

资源链接

• https://hub.docker.com/r/serversideup/github-cli - 浏览镜像
• ******* - 社区支持
• https://github.com/serversideup/docker-github-cli - 源代码和项目管理
• 专业支持 - 核心贡献者提供的视频和屏幕共享支持

贡献指南

作为开源项目，我们欢迎社区贡献。您可以通过以下方式参与：

• 提交Bug报告：在https://github.com/serversideup/docker-github-cli/issues/new/choose%E5%88%9B%E5%BB%BA%E9%97%AE%E9%A2%98
• 功能请求：在https://github.com/serversideup/docker-github-cli/discussions%E6%8F%90%E5%87%BA%E5%BB%BA%E8%AE%AE
• 文档改进：直接提交文档修改
• 社区支持：在***或GitHub Discussions帮助他人
• 安全报告：通过负责任披露政策报告安全问题