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.

81 lines
4.0 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
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 Self Hosted Git Service in the Go Programming Language.
  4. ![Demo](http://gowalker.org/public/gogs_demo.gif)
  5. ##### Current version: 0.3.2 Alpha
  6. ### NOTICES
  7. - Due to testing purpose, data of [try.gogits.org](http://try.gogits.org) has been reset in **April 14, 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. Since we choose to use pure Go implementation of Git manipulation, Gogs certainly supports **ALL platforms** that Go supports, including Linux, Mac OS X, and Windows with **ZERO** dependency.
  13. More importantly, Gogs only needs one binary to setup your own project hosting on the fly!
  14. ## Overview
  15. - Please see [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.
  16. - See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
  17. - Try it before anything? Do it [online](http://try.gogits.org/Unknown/gogs) or go down to **Installation -> Install from binary** section!
  18. - Having troubles? Get help from [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).
  19. ## Features
  20. - Activity timeline
  21. - SSH/HTTP(S) protocol support.
  22. - Register/delete/rename account.
  23. - Create/migrate/mirror/delete/watch/rename/transfer public/private repository.
  24. - Repository viewer/release/issue tracker.
  25. - Add/remove repository collaborators.
  26. - Gravatar and cache support.
  27. - Mail service(register, issue).
  28. - Administration panel.
  29. - Supports MySQL, PostgreSQL and SQLite3.
  30. - Social account login(GitHub, Google, QQ, Weibo)
  31. ## System Requirements
  32. - A cheap Raspberry Pi is powerful enough to match the minimal requirement.
  33. - 4 CPU Cores and 1GB RAM would be the baseline for teamwork.
  34. ## Installation
  35. Make sure you install [Prerequirements](http://gogs.io/docs/installation/) first.
  36. There are 4 ways to install Gogs:
  37. - [Install from binary](http://gogs.io/docs/installation/install_from_binary.md): **STRONGLY RECOMMENDED**
  38. - [Install from source](http://gogs.io/docs/installation/install_from_source.md)
  39. - [Ship with Docker](https://github.com/gogits/gogs/tree/master/dockerfiles)
  40. - [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
  41. ## Acknowledgments
  42. - Router and middleware mechanism of [martini](http://martini.codegangsta.io/).
  43. - Mail Service, modules design is inspired by [WeTalk](https://github.com/beego/wetalk).
  44. - System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
  45. - Usage and modification from [beego](http://beego.me) modules.
  46. - Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
  47. - Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
  48. - Great thanks to [Docker China](http://www.dockboard.org/) for providing [dockerfiles](https://github.com/gogits/gogs/tree/master/dockerfiles).
  49. ## Contributors
  50. This project was launched by [Unknwon](https://github.com/Unknwon) and [lunny](https://github.com/lunny); [fuxiaohei](https://github.com/fuxiaohei), [slene](https://github.com/slene) and [codeskyblue](https://github.com/codeskyblue) joined the team soon after. See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
  51. [![Clone in Koding](http://learn.koding.com/btn/clone_d.png)][koding]
  52. [koding]: https://koding.com/Teamwork?import=https://github.com/gogits/gogs/archive/master.zip&c=git1
  53. ## License
  54. Gogs is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.