2015-02-01 13:36:40 -05:00
Gogs - Go Git Service [](https://travis-ci.org/gogits/gogs)
2014-03-26 11:31:01 -05:00
=====================
2014-12-21 02:53:06 -05:00
[](https://gitter.im/gogits/gogs?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2015-02-14 15:31:07 -05:00
Gogs (Go Git Service) is a painless self-hosted Git service written in Go.
2014-03-15 09:29:18 -05:00
2015-01-27 16:30:58 -05:00
2014-02-12 12:49:46 -05:00
2015-02-24 00:27:22 -05:00
##### Current version: 0.5.15 Beta
2014-03-13 01:55:14 -05:00
2014-04-12 21:30:00 -05:00
### NOTICES
2015-01-27 16:30:58 -05:00
- 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.
2015-02-14 15:31:07 -05:00
- The demo site [try.gogs.io ](https://try.gogs.io ) is running under `dev` branch.
2015-02-24 00:27:22 -05:00
- You **MUST** read [CONTRIBUTING.md ](CONTRIBUTING.md ) before you start filing an issue or making a Pull Request.
2015-02-14 15:31:07 -05:00
- If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io** . Thanks!
2014-03-29 09:01:52 -05:00
2014-03-23 05:27:01 -05:00
#### Other language version
- [简体中文 ](README_ZH.md )
2014-03-22 19:25:39 -05:00
2014-02-12 12:49:46 -05:00
## Purpose
2015-02-14 15:31:07 -05:00
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 via an independent binary distribution across **ALL platforms** that Go supports, including Linux, Mac OS X, and Windows.
2014-02-12 12:49:46 -05:00
2014-02-14 18:16:54 -05:00
## Overview
2015-02-14 15:31:07 -05:00
- Please see the [Documentation ](http://gogs.io/docs/intro/ ) for project design, known issues, and change log.
- See the [Trello Board ](https://trello.com/b/uxAoeLUl/gogs-go-git-service ) to follow the develop team.
- Want to try it before doing anything else? Do it [online ](https://try.gogs.io/unknwon/gogs ) or go down to the **Installation -> Install from binary** section!
- Having trouble? Get help with [Troubleshooting ](http://gogs.io/docs/intro/troubleshooting.md ).
- Want to help with localization? Check out [Crowdin ](https://crowdin.com/project/gogs )!
2014-02-14 18:16:54 -05:00
2014-03-11 18:25:50 -05:00
## Features
2014-03-16 01:28:24 -05:00
- Activity timeline
2014-05-15 22:03:26 -05:00
- SSH/HTTP(S) protocol support
2014-06-21 16:57:59 -05:00
- SMTP/LDAP/reverse proxy authentication support
2014-10-10 20:40:51 -05:00
- Reverse proxy suburl support
2014-05-15 22:03:26 -05:00
- Register/delete/rename account
2014-08-29 02:32:52 -05:00
- Create/manage/delete organization with team management
2014-11-05 23:30:04 -05:00
- Create/fork/migrate/mirror/delete/watch/rename/transfer public/private repository
2014-09-07 18:39:26 -05:00
- Repository viewer/release/issue tracker
- Repository and Organization level webhooks
2014-10-11 17:02:48 -05:00
- Repository Git hooks
2014-05-15 22:03:26 -05:00
- Add/remove repository collaborators
- Gravatar and cache support
2015-02-14 15:31:07 -05:00
- Mail service (register, issue)
2014-05-15 22:03:26 -05:00
- Administration panel
2014-09-02 06:11:39 -05:00
- Slack webhook integration
2014-11-17 16:29:23 -05:00
- Drone CI integration
2014-05-15 22:03:26 -05:00
- Supports MySQL, PostgreSQL and SQLite3
2015-02-14 15:31:07 -05:00
- Social account login (GitHub, Google, QQ, Weibo)
- Multi-language support ([10 languages](https://crowdin.com/project/gogs))
2014-03-11 18:25:50 -05:00
2014-04-26 02:22:22 -05:00
## System Requirements
2015-02-14 15:31:07 -05:00
- A cheap Raspberry Pi is powerful enough for basic functionality.
2015-02-24 00:27:22 -05:00
- At least 2 CPU cores and 1GB RAM would be the baseline for teamwork.
2014-04-26 02:22:22 -05:00
2014-02-14 18:16:54 -05:00
## Installation
2015-02-14 15:31:07 -05:00
Make sure you install the [prerequisites ](http://gogs.io/docs/installation/ ) first.
2014-03-11 23:19:45 -05:00
2014-05-12 10:02:36 -05:00
There are 5 ways to install Gogs:
2014-02-14 18:16:54 -05:00
2014-10-10 05:15:27 -05:00
- [Install from binary ](http://gogs.io/docs/installation/install_from_binary.md )
2014-05-01 02:27:26 -05:00
- [Install from source ](http://gogs.io/docs/installation/install_from_source.md )
2014-05-12 10:02:36 -05:00
- [Install from packages ](http://gogs.io/docs/installation/install_from_packages.md )
2014-09-05 16:28:09 -05:00
- [Ship with Docker ](https://github.com/gogits/gogs/tree/master/docker )
2014-05-02 18:23:06 -05:00
- [Install with Vagrant ](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs )
2014-02-14 18:16:54 -05:00
2014-02-12 12:49:46 -05:00
## Acknowledgments
2014-09-29 17:52:28 -05:00
- Router and middleware mechanism of [Macaron ](https://github.com/Unknwon/macaron ).
2014-03-22 16:59:22 -05:00
- Mail Service, modules design is inspired by [WeTalk ](https://github.com/beego/wetalk ).
- System Monitor Status is inspired by [GoBlog ](https://github.com/fuxiaohei/goblog ).
2014-04-30 02:44:28 -05:00
- Thanks [lavachen ](http://www.lavachen.cn/ ) and [Rocker ](http://weibo.com/rocker1989 ) for designing Logo.
2014-03-24 10:44:47 -05:00
- Thanks [gobuild.io ](http://gobuild.io ) for providing binary compile and download service.
2014-11-17 17:19:17 -05:00
- Thanks [Crowdin ](https://crowdin.com/project/gogs ) for providing open source translation plan.
2014-02-12 12:49:46 -05:00
## Contributors
2015-02-07 11:09:17 -05:00
- The [core team ](http://gogs.io/team ) of this project.
2014-11-22 10:22:53 -05:00
- See [contributors page ](https://github.com/gogits/gogs/graphs/contributors ) for full list of contributors.
- See [TRANSLATORS ](conf/locale/TRANSLATORS ) for full list of translators.
2014-03-27 11:34:12 -05:00
## License
2014-05-24 14:28:31 -05:00
This project is under the MIT License. See the [LICENSE ](https://github.com/gogits/gogs/blob/master/LICENSE ) file for the full license text.
