freenas/gogs

Gogs Docker镜像文档

镜像概述和主要用途

Gogs（Go Git Service）是一个简单易用的自托管Git服务，旨在提供轻量级、易于部署和使用的Git服务器解决方案。通过Docker镜像，用户可以快速部署Gogs，实现代码仓库的自托管管理。

核心功能和特性

• 轻量级设计，资源占用低
• 支持Git核心功能，包括仓库管理、分支操作和合并等
• 提供Web界面，方便用户操作
• 支持SSH和HTTP/HTTPS协议访问仓库
• 可通过数据卷持久化存储仓库数据和配置

使用场景和适用范围

适用于个人开发者、小型团队或企业内部，需要搭建私有的Git仓库服务，实现代码的版本控制和协作管理。尤其适合资源有限的环境，如个人服务器、小型服务器集群等场景。

使用方法和配置说明

基本部署

为避免数据存放在Docker容器内，建议使用数据卷将容器内的/data目录映射到宿主机的本地路径（如/var/gogs），具体路径可根据实际情况调整。

注意：首次设置Gogs时，必须将容器内的SSH服务端口映射到宿主机，并正确配置SSH端口和URI设置。例如，使用上述配置访问和克隆Gogs仓库时，命令格式为：git clone ssh://git@hostname:10022/username/myrepo.git。

文件将存储在宿主机的/var/gogs路径下，该目录包含Git仓库和Gogs数据：

/var/gogs
|-- git
|   |-- gogs-repositories  # Git仓库存储目录
|-- ssh
|   |-- # Gogs的SSH公钥/私钥
|-- gogs
    |-- conf               # 配置文件目录
    |-- data               # 应用数据目录
    |-- log                # 日志目录

Docker运行示例：

bash
docker run -d \
  --name=gogs \
  -p 10022:22 \  # SSH端口映射
  -p 10080:3000 \  # HTTP端口映射
  -v /var/gogs:/data \  # 数据卷挂载
  gogs/gogs

配置说明

应用设置

大多数设置简单易懂，但在Docker中运行Gogs时，以下设置需要特别注意：

• 仓库根路径（Repository Root Path）：保持默认值/home/git/gogs-repositories，因为start.sh已为此创建符号链接。
• 运行用户（Run User）：保持默认值git，因为start.sh已创建名为git的用户。
• 域名（Domain）：填写Docker容器IP（如192.168.99.100）。若需从其他物理机访问Gogs实例，请填写Docker宿主机的主机名或IP地址。
• SSH端口（SSH Port）：使用Docker容器暴露的端口。例如，容器内SSH服务监听22端口，宿主机映射为10022:22，则此处填写10022。不建议在Docker容器内使用内置SSH服务器。
• HTTP端口（HTTP Port）：填写Gogs在容器内监听的端口。例如，容器内Gogs监听3000端口，宿主机映射为10080:3000，此处仍填写3000。
• 应用URL（Application URL）：结合域名和暴露的HTTP端口填写（如http://192.168.99.100:10080/）。

应用设置的完整文档可参考官方配置指南。

容器选项

该容器通过环境变量提供一些可选功能，用于辅助容器管理：

• SOCAT_LINK：

  • 可能值：true、false、1、0
  • 默认值：true
  • 作用：使用socat将链接的Docker容器绑定到本地socket。链接容器的所有暴露端口将绑定到本地对应端口。
  • 注意：由于此选项依赖Docker链接容器时创建的环境变量，在Rancher或Kubernetes等托管环境中应禁用（设置为0或false）。

• RUN_CROND：

  • 可能值：true、false、1、0
  • 默认值：false
  • 作用：在容器内运行crond。默认配置会定期运行/etc/periodic/${period}目录下的所有脚本，也可将自定义crontab添加到/var/spool/cron/crontabs/。