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.

91 lines
4.2 KiB

10 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
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 [![Build Status](https://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/gogs)
  2. =====================
  3. [![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)
  4. Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.
  5. ![Demo](http://gogs.qiniudn.com/gogs_demo.gif)
  6. ##### Current version: 0.5.13 Beta
  7. ### NOTICES
  8. - Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) has been reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
  9. - Demo site [try.gogs.io](https://try.gogs.io) is running under `dev` branch.
  10. - You **MUST** read [CONTRIBUTING.md](CONTRIBUTING.md) before you start filing a issue or making a Pull Request.
  11. - If you think there are vulnerabilities in the project, please talk private to **u@gogs.io**, thanks!
  12. #### Other language version
  13. - [简体中文](README_ZH.md)
  14. ## Purpose
  15. 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.
  16. ## Overview
  17. - Please see [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.
  18. - See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
  19. - Try it before anything? Do it [online](https://try.gogs.io/Unknown/gogs) or go down to **Installation -> Install from binary** section!
  20. - Having troubles? Get help from [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).
  21. - Want to help on localization? Check out [Crowdin](https://crowdin.com/project/gogs)!
  22. ## Features
  23. - Activity timeline
  24. - SSH/HTTP(S) protocol support
  25. - SMTP/LDAP/reverse proxy authentication support
  26. - Reverse proxy suburl support
  27. - Register/delete/rename account
  28. - Create/manage/delete organization with team management
  29. - Create/fork/migrate/mirror/delete/watch/rename/transfer public/private repository
  30. - Repository viewer/release/issue tracker
  31. - Repository and Organization level webhooks
  32. - Repository Git hooks
  33. - Add/remove repository collaborators
  34. - Gravatar and cache support
  35. - Mail service(register, issue)
  36. - Administration panel
  37. - Slack webhook integration
  38. - Drone CI integration
  39. - Supports MySQL, PostgreSQL and SQLite3
  40. - Social account login(GitHub, Google, QQ, Weibo)
  41. - Multi-language support([9 languages](https://crowdin.com/project/gogs))
  42. ## System Requirements
  43. - A cheap Raspberry Pi is powerful enough to match the minimal requirement.
  44. - 4 CPU Cores and 1GB RAM would be the baseline for teamwork.
  45. ## Installation
  46. Make sure you install [Prerequirements](http://gogs.io/docs/installation/) first.
  47. There are 5 ways to install Gogs:
  48. - [Install from binary](http://gogs.io/docs/installation/install_from_binary.md)
  49. - [Install from source](http://gogs.io/docs/installation/install_from_source.md)
  50. - [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)
  51. - [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
  52. - [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
  53. ## Acknowledgments
  54. - Router and middleware mechanism of [Macaron](https://github.com/Unknwon/macaron).
  55. - Mail Service, modules design is inspired by [WeTalk](https://github.com/beego/wetalk).
  56. - System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
  57. - Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
  58. - Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
  59. - Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
  60. ## Contributors
  61. - The [core team](http://gogs.io/team) of this project.
  62. - See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
  63. - See [TRANSLATORS](conf/locale/TRANSLATORS) for full list of translators.
  64. ## License
  65. This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.