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.

84 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
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://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/gogs)
  2. =====================
  3. Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.
  4. ![Demo](https://gowalker.org/public/gogs_demo.gif)
  5. ##### Current version: 0.5.8 Beta
  6. ### NOTICES
  7. - Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) 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.gogs.io](https://try.gogs.io) 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](https://try.gogs.io/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. - Reverse proxy suburl support
  23. - Register/delete/rename account
  24. - Create/manage/delete organization with team management
  25. - Create/fork/migrate/mirror/delete/watch/rename/transfer public/private repository
  26. - Repository viewer/release/issue tracker
  27. - Repository and Organization level webhooks
  28. - Repository Git hooks
  29. - Add/remove repository collaborators
  30. - Gravatar and cache support
  31. - Mail service(register, issue)
  32. - Administration panel
  33. - Slack webhook integration
  34. - Drone CI integration
  35. - Supports MySQL, PostgreSQL and SQLite3
  36. - Social account login(GitHub, Google, QQ, Weibo)
  37. - Multi-language support(English, Simplified Chinese, Traditional Chinese, Germany, French, Dutch, and [more](https://crowdin.com/project/gogs))
  38. ## System Requirements
  39. - A cheap Raspberry Pi is powerful enough to match the minimal requirement.
  40. - 4 CPU Cores and 1GB RAM would be the baseline for teamwork.
  41. ## Installation
  42. Make sure you install [Prerequirements](http://gogs.io/docs/installation/) first.
  43. There are 5 ways to install Gogs:
  44. - [Install from binary](http://gogs.io/docs/installation/install_from_binary.md)
  45. - [Install from source](http://gogs.io/docs/installation/install_from_source.md)
  46. - [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)
  47. - [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
  48. - [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
  49. ## Acknowledgments
  50. - Router and middleware mechanism of [Macaron](https://github.com/Unknwon/macaron).
  51. - Mail Service, modules design is inspired by [WeTalk](https://github.com/beego/wetalk).
  52. - System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
  53. - Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
  54. - Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
  55. - Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
  56. ## Contributors
  57. 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.
  58. ## License
  59. This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.