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.

131 lines
7.1 KiB

10 years ago
10 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) [![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.9.6
  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. ### Important Notes
  11. 1. **YOU MUST READ [Contributing Code](https://github.com/gogits/gogs/wiki/Contributing-Code) BEFORE STARTING TO WORK ON A PULL REQUEST**.
  12. 2. 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.
  13. 3. The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
  14. 4. If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!
  15. 5. If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogits/go-gogs-client/wiki).
  16. 6. 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.
  17. [简体中文](README_ZH.md)
  18. ## Purpose
  19. 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.
  20. ## Overview
  21. - Please see the [Documentation](http://gogs.io/docs/intro) for common usages and change log.
  22. - See the [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
  23. - Want to try it before doing anything else? Do it [online](https://try.gogs.io/gogs/gogs)!
  24. - Having trouble? Get help with [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.html) or [User Forum](https://discuss.gogs.io/).
  25. - Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!
  26. ## Features
  27. - Activity timeline
  28. - SSH and HTTP/HTTPS protocols
  29. - SMTP/LDAP/Reverse proxy authentication
  30. - Reverse proxy with sub-path
  31. - Account/Organization/Repository management
  32. - Repository/Organization webhooks (including Slack)
  33. - Repository Git hooks/deploy keys
  34. - Repository issues, pull requests and wiki
  35. - Add/Remove repository collaborators
  36. - Gravatar and custom source
  37. - Mail service
  38. - Administration panel
  39. - Supports MySQL, PostgreSQL, SQLite3 and [TiDB](https://github.com/pingcap/tidb) (experimental)
  40. - Multi-language support ([15 languages](https://crowdin.com/project/gogs))
  41. ## System Requirements
  42. - A cheap Raspberry Pi is powerful enough for basic functionality.
  43. - 2 CPU cores and 1GB RAM would be the baseline for teamwork.
  44. ## Browser Support
  45. - Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers.
  46. - The official support minimal size is **1024*768**, UI may still looks right in smaller size but no promises and fixes.
  47. ## Installation
  48. Make sure you install the [prerequisites](http://gogs.io/docs/installation) first.
  49. There are 5 ways to install Gogs:
  50. - [Install from binary](http://gogs.io/docs/installation/install_from_binary.html)
  51. - [Install from source](http://gogs.io/docs/installation/install_from_source.html)
  52. - [Install from packages](http://gogs.io/docs/installation/install_from_packages.html)
  53. - [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
  54. - [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
  55. ### Tutorials
  56. - [How To Set Up Gogs on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-gogs-on-ubuntu-14-04)
  57. - [Run your own GitHub-like service with the help of Docker](http://blog.hypriot.com/post/run-your-own-github-like-service-with-docker/)
  58. - [使用 Gogs 搭建自己的 Git 服务器](https://mynook.info/blog/post/host-your-own-git-server-using-gogs) (Chinese)
  59. - [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) (Chinese)
  60. - [Installing Gogs on FreeBSD](https://www.codejam.info/2015/03/installing-gogs-on-freebsd.html)
  61. - [Gogs on Raspberry Pi](http://blog.meinside.pe.kr/Gogs-on-Raspberry-Pi/)
  62. - [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/)
  63. ### Screencasts
  64. - [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=4UkHAR1F7ZA) (Português)
  65. ### Deploy to Cloud
  66. - [OpenShift](https://github.com/tkisme/gogs-openshift)
  67. - [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
  68. - [Scaleway](https://www.scaleway.com/imagehub/gogs/)
  69. - [Portal](https://portaldemo.xyz/cloud/)
  70. - [Sandstorm](https://github.com/cem/gogs-sandstorm)
  71. - [sloppy.io](https://github.com/sloppyio/quickstarters/tree/master/gogs)
  72. - [YunoHost](https://github.com/mbugeia/gogs_ynh)
  73. ## Software and Service Support
  74. - [Drone](https://github.com/drone/drone) (CI)
  75. - [Fabric8](http://fabric8.io/) (DevOps)
  76. - [Taiga](https://taiga.io/) (Project Management)
  77. - [Puppet](https://forge.puppetlabs.com/Siteminds/gogs) (IT)
  78. - [Kanboard](http://kanboard.net/plugin/gogs-webhook) (Project Management)
  79. - [BearyChat](https://bearychat.com/) (Team Communication)
  80. ### Product Support
  81. - [Synology](https://www.synology.com) (Docker)
  82. - [One Space](http://www.onespace.cc) (App Store)
  83. ## Acknowledgments
  84. - Router and middleware mechanism of [Macaron](https://github.com/go-macaron/macaron).
  85. - System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
  86. - Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
  87. - Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
  88. - Thanks [DigitalOcean](https://www.digitalocean.com) for hosting home and demo sites.
  89. - Thanks [KeyCDN](https://www.keycdn.com/) for providing CDN service.
  90. ## Contributors
  91. - Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
  92. - See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
  93. - See [TRANSLATORS](conf/locale/TRANSLATORS) for public list of translators.
  94. ## License
  95. This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.