Files
Gogs/README_ZH.md

104 lines
5.2 KiB
Markdown
Raw Normal View History

# Gogs
2014-03-22 20:25:39 -04:00
2017-02-15 22:29:31 -05:00
Gogs 是一款极易搭建的自助 Git 服务。
2014-03-22 20:25:39 -04:00
2018-09-14 15:25:15 -04:00
## 项目愿景
2014-03-22 20:25:39 -04:00
Gogs`/gɑgz/`)项目旨在打造一个以最简便的方式搭建简单、稳定和可扩展的自助 Git 服务。使用 Go 语言开发使得 Gogs 能够通过独立的二进制分发,并且支持 Go 语言支持的 **所有平台**,包括 Linux、macOS、Windows 以及 ARM 平台。
2014-03-22 20:25:39 -04:00
2020-02-18 19:48:46 +08:00
## 概览
2014-03-22 20:25:39 -04:00
2020-02-18 19:48:46 +08:00
- 请移步[官网](https://gogs.io)查看用户使用文档
- 请通过 [CHANGELOG.md](CHANGELOG.md) 文件查看各个版本的变更历史
- 想要先睹为快?直接去[在线体验](https://try.gogs.io/gogs/gogs)吧!
- 使用过程中遇到问题?尝试[故障排查](https://gogs.io/docs/intro/troubleshooting.html)或者前往[用户论坛](https://discuss.gogs.io/)获取帮助
- 希望帮助多国语言的翻译吗?请查看[本地化文档](https://gogs.io/docs/features/i18n.html)
2020-10-01 12:21:50 +08:00
- 准备搞点事情?请阅读[开发指南](docs/dev/local_development.md)配置开发环境
- 想调用 API 吗?请查看[文档](https://github.com/gogs/docs-api)吧
2014-03-22 20:25:39 -04:00
2020-02-18 19:24:39 +08:00
## 主要特性
- 控制面板、用户页面以及活动时间线
- 通过 SSH、HTTP 和 HTTPS 协议操作仓库
- 管理用户、组织和仓库
- 仓库和组织级 Webhook包括 Slack、Discord 和钉钉
2020-05-10 20:37:22 +08:00
- 仓库 Git 钩子、部署密钥和 Git LFS
2020-02-18 19:24:39 +08:00
- 仓库工单Issue、合并请求Pull Request、Wiki、保护分支和多人协作
- 从其它代码平台迁移和镜像仓库以及 Wiki
- 在线编辑仓库文件和 Wiki
- Jupyter Notebook 和 PDF 的渲染
- 通过 SMTP、LDAP、反向代理、GitHub.com 和 GitHub 企业版进行用户认证
- 开启两步验证2FA登录
- 自定义 HTML 模板、静态文件和许多其它组件
- 多样的数据库后端,包括 PostgreSQL、MySQL、SQLite3 和 [TiDB](https://github.com/pingcap/tidb)
2020-02-18 19:24:39 +08:00
- 超过[30 种语言](https://crowdin.com/project/gogs)的本地化
2014-03-22 20:25:39 -04:00
2017-02-19 14:42:06 -05:00
## 硬件要求
2014-04-26 01:22:22 -06:00
- 最低的系统硬件要求为一个廉价的树莓派
2017-02-19 14:42:06 -05:00
- 如果用于团队项目管理,建议使用 2 核 CPU 及 512MB 内存
- 当团队成员大量增加时,可以考虑添加 CPU 核数,内存占用保持不变
2014-04-26 01:22:22 -06:00
2015-07-07 13:51:28 +08:00
## 浏览器支持
- 请根据 [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) 查看具体支持的浏览器版本。
- 官方支持的最小 UI 尺寸为 **1024*768**UI 不一定会在更小尺寸的设备上被破坏,但我们无法保证且不会修复。
2015-07-24 04:50:05 +08:00
2014-03-22 20:25:39 -04:00
## 安装部署
在安装 Gogs 之前,您需要先安装 [基本环境](https://gogs.io/docs/installation)。
2014-03-22 20:25:39 -04:00
2019-02-25 17:57:53 -05:00
然后,您可以通过以下 6 种方式来安装 Gogs
2014-03-22 20:25:39 -04:00
- [二进制安装](https://gogs.io/docs/installation/install_from_binary.html)
- [源码安装](https://gogs.io/docs/installation/install_from_source.html)
- [包管理安装](https://gogs.io/docs/installation/install_from_packages.html)
- [采用 Docker 部署](https://github.com/gogs/gogs/tree/main/docker)
2014-05-02 19:23:06 -04:00
- [通过 Vagrant 安装](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
2019-02-25 17:57:53 -05:00
- [通过基于 Kubernetes 的 Helm Charts](https://github.com/helm/charts/tree/master/incubator/gogs)
2014-03-22 20:25:39 -04:00
2015-10-29 03:21:59 -04:00
### 云端部署
- [OpenShift](https://github.com/tkisme/gogs-openshift)
- [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
- [Scaleway](https://www.scaleway.com/imagehub/gogs/)
- [Sandstorm](https://github.com/cem/gogs-sandstorm)
2015-12-01 19:53:19 -05:00
- [sloppy.io](https://github.com/sloppyio/quickstarters/tree/master/gogs)
2016-02-05 10:19:37 -05:00
- [YunoHost](https://github.com/mbugeia/gogs_ynh)
- [DPlatform](https://github.com/j8r/DPlatform)
2019-01-30 23:22:50 -05:00
- [LunaNode](https://github.com/LunaNode/launchgogs)
2015-10-29 03:21:59 -04:00
2020-02-18 19:48:46 +08:00
### 使用教程
- [使用 Gogs 搭建自己的 Git 服务器](https://blog.mynook.info/post/host-your-own-git-server-using-gogs/)
- [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654)
## 软件、服务以及产品支持
2015-12-05 13:50:43 -05:00
- [Fabric8](http://fabric8.io/)DevOps
2020-02-18 19:48:46 +08:00
- [Jenkins](https://plugins.jenkins.io/gogs-webhook/)CI
2015-12-05 13:50:43 -05:00
- [Taiga](https://taiga.io/)(项目管理)
2020-02-18 19:48:46 +08:00
- [Puppet](https://forge.puppet.com/Siteminds/gogs)IT
- [Kanboard](https://github.com/kanboard/plugin-gogs-webhook)(项目管理)
2016-01-14 14:28:07 +08:00
- [BearyChat](https://bearychat.com/)(团队交流)
2017-06-05 00:59:08 -04:00
- [GitPitch](https://gitpitch.com/)Markdown 演示)
2015-10-29 03:21:59 -04:00
- [Synology](https://www.synology.com)Docker
- [Syncloud](https://syncloud.org/)(应用商店)
2015-10-29 03:21:59 -04:00
2014-03-22 20:25:39 -04:00
## 特别鸣谢
2017-02-13 19:11:31 -05:00
- 感谢 [Egon Elbre](https://twitter.com/egonelbre) 设计的 Logo。
2014-10-18 23:26:55 -04:00
- 感谢 [Crowdin](https://crowdin.com/project/gogs) 提供免费的开源项目本地化支持。
- 感谢 [DigitalOcean](https://www.digitalocean.com)、[VPSServer](https://www.vpsserver.com/)、[Hosted.nl](https://www.hosted.nl/)、[MonoVM](https://monovm.com) 和 [BitLaunch](https://bitlaunch.io) 提供服务器赞助。
2018-03-30 23:26:48 -04:00
- 感谢 [KeyCDN](https://www.keycdn.com/) 提供 CDN 服务赞助。
2019-08-04 17:20:51 -07:00
- 感谢 [Buildkite](https://buildkite.com) 提供免费的开源项目 CI/CD 支持。
2014-03-22 20:25:39 -04:00
## 贡献成员
2018-05-27 09:07:15 +08:00
- 您可以通过查看 [贡献者页面](https://github.com/gogs/gogs/graphs/contributors) 获取 TOP 100 的贡献者列表。
2015-09-04 05:54:22 -04:00
- 您可以通过查看 [TRANSLATORS](conf/locale/TRANSLATORS) 文件获取公开的翻译人员列表。
2014-03-27 12:48:29 -04:00
## 授权许可
本项目采用 MIT 开源授权许可证,完整的授权说明已放置在 [LICENSE](https://github.com/gogs/gogs/blob/main/LICENSE) 文件中。