You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

133 lines
7.5 KiB

9 years ago
10 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
9 years ago
10 years ago
10 years ago
9 years ago
10 years ago
10 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
9 years ago
8 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
9 years ago
10 years ago
9 years ago
10 years ago
10 years ago
  1. Gogs - Go Git Service [![Build Status](https://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/gogs) [![Docker Repository on Quay](https://quay.io/repository/gogs/gogs/status "Docker Repository on Quay")](https://quay.io/repository/gogs/gogs) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/gogs/localized.svg)](https://crowdin.com/project/gogs) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gogits/gogs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
  2. =====================
  3. ![](https://github.com/gogits/gogs/blob/master/public/img/gogs-large-resize.png?raw=true)
  4. ##### Current version: 0.8.33
  5. | Web | UI | Preview |
  6. |:-------------:|:-------:|:-------:|
  7. |![Dashboard](https://gogs.io/img/screenshots/1.png)|![Repository](https://gogs.io/img/screenshots/2.png)|![Commits History](https://gogs.io/img/screenshots/3.png)|
  8. |![Profile](https://gogs.io/img/screenshots/4.png)|![Admin Dashboard](https://gogs.io/img/screenshots/5.png)|![Diff](https://gogs.io/img/screenshots/6.png)|
  9. |![Issues](https://gogs.io/img/screenshots/7.png)|![Releases](https://gogs.io/img/screenshots/8.png)|![Organization](https://gogs.io/img/screenshots/9.png)|
  10. ### NOTICES
  11. - :bangbang: You **MUST** read [CONTRIBUTING.md](CONTRIBUTING.md) for bug report and contributing code. :bangbang:
  12. - Please [start discussion](http://forum.gogs.io/category/2/general-discussion) or [ask a question](http://forum.gogs.io/category/4/getting-help) on [the forum](http://forum.gogs.io/). GitHub issue tracker only keeps **bugs** and **feature requests**, all other topics will be closed without reason.
  13. - Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) was reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
  14. - The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
  15. - If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!
  16. - If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogits/go-gogs-client/wiki).
  17. - If your team/company is using Gogs and would like to put your logo on [our website](http://gogs.io), contact us by any means.
  18. [简体中文](README_ZH.md)
  19. ## Purpose
  20. The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across **ALL platforms** that Go supports, including Linux, Mac OS X, Windows and ARM.
  21. ## Overview
  22. - Please see the [Documentation](http://gogs.io/docs/intro) for common usages and change log.
  23. - See the [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
  24. - Want to try it before doing anything else? Do it [online](https://try.gogs.io/gogs/gogs)!
  25. - Having trouble? Get help with [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.html).
  26. - Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!
  27. ## Features
  28. - Activity timeline
  29. - SSH and HTTP/HTTPS protocols
  30. - SMTP/LDAP/Reverse proxy authentication
  31. - Reverse proxy with sub-path
  32. - Account/Organization/Repository management
  33. - Repository/Organization webhooks (including Slack)
  34. - Repository Git hooks/deploy keys
  35. - Repository issues, pull requests and wiki
  36. - Add/Remove repository collaborators
  37. - Gravatar and custom source
  38. - Mail service
  39. - Administration panel
  40. - Supports MySQL, PostgreSQL, SQLite3 and [TiDB](https://github.com/pingcap/tidb) (experimental)
  41. - Multi-language support ([14 languages](https://crowdin.com/project/gogs))
  42. ## System Requirements
  43. - A cheap Raspberry Pi is powerful enough for basic functionality.
  44. - 2 CPU cores and 1GB RAM would be the baseline for teamwork.
  45. ## Browser Support
  46. - Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers.
  47. - The official support minimal size is **1024*768**, UI may still looks right in smaller size but no promises and fixes.
  48. ## Installation
  49. Make sure you install the [prerequisites](http://gogs.io/docs/installation) first.
  50. There are 5 ways to install Gogs:
  51. - [Install from binary](http://gogs.io/docs/installation/install_from_binary.html)
  52. - [Install from source](http://gogs.io/docs/installation/install_from_source.html)
  53. - [Install from packages](http://gogs.io/docs/installation/install_from_packages.html)
  54. - [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
  55. - [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
  56. ### Tutorials
  57. - [How To Set Up Gogs on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-gogs-on-ubuntu-14-04)
  58. - [Run your own GitHub-like service with the help of Docker](http://blog.hypriot.com/post/run-your-own-github-like-service-with-docker/)
  59. - [使用 Gogs 搭建自己的 Git 服务器](https://mynook.info/blog/post/host-your-own-git-server-using-gogs) (Chinese)
  60. - [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) (Chinese)
  61. - [Installing Gogs on FreeBSD](https://www.codejam.info/2015/03/installing-gogs-on-freebsd.html)
  62. - [Gogs on Raspberry Pi](http://blog.meinside.pe.kr/Gogs-on-Raspberry-Pi/)
  63. - [Cloudflare Full SSL with GOGS (Go Git Service) using NGINX](http://www.listekconsulting.com/articles/cloudflare-full-ssl-with-gogs-go-git-service-using-nginx/)
  64. ### Screencasts
  65. - [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=4UkHAR1F7ZA) (Português)
  66. ### Deploy to Cloud
  67. - [OpenShift](https://github.com/tkisme/gogs-openshift)
  68. - [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
  69. - [Scaleway](https://www.scaleway.com/imagehub/gogs/)
  70. - [Portal](https://portaldemo.xyz/cloud/)
  71. - [Sandstorm](https://github.com/cem/gogs-sandstorm)
  72. - [sloppy.io](https://github.com/sloppyio/quickstarters/tree/master/gogs)
  73. - [YunoHost](https://github.com/mbugeia/gogs_ynh)
  74. ## Software and Service Support
  75. - [Drone](https://github.com/drone/drone) (CI)
  76. - [Fabric8](http://fabric8.io/) (DevOps)
  77. - [Taiga](https://taiga.io/) (Project Management)
  78. - [Puppet](https://forge.puppetlabs.com/Siteminds/gogs) (IT)
  79. - [Kanboard](http://kanboard.net/plugin/gogs-webhook) (Project Management)
  80. - [BearyChat](https://bearychat.com/) (Team Communication)
  81. ### Product Support
  82. - [Synology](https://www.synology.com) (Docker)
  83. - [One Space](http://www.onespace.cc) (App Store)
  84. ## Acknowledgments
  85. - Router and middleware mechanism of [Macaron](https://github.com/go-macaron/macaron).
  86. - Modules design is inspired by [WeTalk](https://github.com/beego/wetalk).
  87. - System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
  88. - Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
  89. - Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
  90. - Thanks [DigitalOcean](https://www.digitalocean.com) for hosting home and demo sites.
  91. - Thanks [KeyCDN](https://www.keycdn.com/) for providing CDN service.
  92. ## Contributors
  93. - Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
  94. - See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
  95. - See [TRANSLATORS](conf/locale/TRANSLATORS) for public list of translators.
  96. ## License
  97. This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.