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.

80 lines
3.9 KiB

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
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
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
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
10 years ago
10 years ago
  1. Gogs - Go Git Service [![wercker status](https://app.wercker.com/status/ad0bdb0bc450ac6f09bc56b9640a50aa/s/ "wercker status")](https://app.wercker.com/project/bykey/ad0bdb0bc450ac6f09bc56b9640a50aa) [![Build Status](https://drone.io/github.com/gogits/gogs/status.png)](https://drone.io/github.com/gogits/gogs/latest)
  2. =====================
  3. Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.
  4. ![Demo](http://gowalker.org/public/gogs_demo.gif)
  5. ##### Current version: 0.4.9 Beta
  6. ### NOTICES
  7. - Due to testing purpose, data of [try.gogits.org](http://try.gogits.org) has been reset in **June 21, 2014** and will reset multiple times after. Please do **NOT** put your important data on the site.
  8. - Demo site [try.gogits.org](http://try.gogits.org) is running under `dev` branch.
  9. #### Other language version
  10. - [简体中文](README_ZH.md)
  11. ## Purpose
  12. The goal of this project is to make the easiest, fastest and most painless way to set up a self-hosted Git service. With Go, this can be done in independent binary distribution across **ALL platforms** that Go supports, including Linux, Mac OS X, and Windows.
  13. ## Overview
  14. - Please see [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.
  15. - See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
  16. - Try it before anything? Do it [online](http://try.gogits.org/Unknown/gogs) or go down to **Installation -> Install from binary** section!
  17. - Having troubles? Get help from [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).
  18. ## Features
  19. - Activity timeline
  20. - SSH/HTTP(S) protocol support
  21. - SMTP/LDAP/reverse proxy authentication support
  22. - Register/delete/rename account
  23. - Create/manage/delete organization with team management
  24. - Create/migrate/mirror/delete/watch/rename/transfer public/private repository
  25. - Repository viewer/release/issue tracker/webhooks
  26. - Add/remove repository collaborators
  27. - Gravatar and cache support
  28. - Mail service(register, issue)
  29. - Administration panel
  30. - Supports MySQL, PostgreSQL and SQLite3
  31. - Social account login(GitHub, Google, QQ, Weibo)
  32. - Multi-language support(English, Chinese, Germany etc.)
  33. ## System Requirements
  34. - A cheap Raspberry Pi is powerful enough to match the minimal requirement.
  35. - 4 CPU Cores and 1GB RAM would be the baseline for teamwork.
  36. ## Installation
  37. Make sure you install [Prerequirements](http://gogs.io/docs/installation/) first.
  38. There are 5 ways to install Gogs:
  39. - [Install from binary](http://gogs.io/docs/installation/install_from_binary.md): **STRONGLY RECOMMENDED**
  40. - [Install from source](http://gogs.io/docs/installation/install_from_source.md)
  41. - [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)
  42. - [Ship with Docker](https://github.com/gogits/gogs/tree/master/dockerfiles)
  43. - [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
  44. ## Acknowledgments
  45. - Router and middleware mechanism of [martini](http://martini.codegangsta.io/).
  46. - Mail Service, modules design is inspired by [WeTalk](https://github.com/beego/wetalk).
  47. - System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
  48. - Usage and modification from [beego](http://beego.me) modules.
  49. - Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
  50. - Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
  51. - Great thanks to [Docker China](http://www.dockboard.org/) for providing [dockerfiles](https://github.com/gogits/gogs/tree/master/dockerfiles).
  52. ## Contributors
  53. The [core team](http://gogs.io/team) of this project. See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
  54. ## License
  55. This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.