2015-02-01 13:36:40 -05:00
Gogs - Go Git Service [![Build Status ](https://travis-ci.org/gogits/gogs.svg?branch=master )](https://travis-ci.org/gogits/gogs)
2014-03-26 11:31:01 -05:00
=====================
2014-12-21 02:53:06 -05:00
[![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)
2015-09-12 15:58:18 -05:00
![](public/img/gogs-large-resize.png)
2014-03-15 09:29:18 -05:00
2015-09-17 14:45:36 -05:00
##### Current version: 0.6.13 Beta
2014-03-13 01:55:14 -05:00
2015-08-15 12:41:11 -05:00
< table >
< tr >
2015-08-15 12:44:41 -05:00
< td width = "33%" > < img src = "http://gogs.io/imgs/screenshoots/1.png" > < / td >
< td width = "33%" > < img src = "http://gogs.io/imgs/screenshoots/2.png" > < / td >
< td width = "33%" > < img src = "http://gogs.io/imgs/screenshoots/3.png" > < / td >
2015-08-15 12:41:11 -05:00
< / tr >
< tr >
< td > < img src = "http://gogs.io/imgs/screenshoots/4.png" > < / td >
< td > < img src = "http://gogs.io/imgs/screenshoots/5.png" > < / td >
< td > < img src = "http://gogs.io/imgs/screenshoots/6.png" > < / td >
< / tr >
< tr >
< td > < img src = "http://gogs.io/imgs/screenshoots/7.png" > < / td >
< td > < img src = "http://gogs.io/imgs/screenshoots/8.png" > < / td >
< td > < img src = "http://gogs.io/imgs/screenshoots/9.png" > < / td >
< / tr >
< / table >
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-03-18 06:00:55 -05:00
- The demo site [try.gogs.io ](https://try.gogs.io ) is running under `develop` branch.
2015-09-01 05:34:14 -05:00
- :exclamation::exclamation::exclamation:< span style = "color: red" > You **MUST** read [CONTRIBUTING.md ](CONTRIBUTING.md ) before you start filing an issue or making a Pull Request, and **MUST** discuss with us on [Gitter ](https://gitter.im/gogits/gogs ) for UI changes and feature Pull Requests, otherwise it's high possibilities that we are not going to merge it.</ span > :exclamation::exclamation::exclamation:
2015-03-18 22:20:41 -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.
2015-09-03 16:25:33 -05:00
- Want to try it before doing anything else? Do it [online ](https://try.gogs.io/gogs/gogs ) or go down to the **Installation -> Install from binary** section!
2015-02-14 15:31:07 -05:00
- Having trouble? Get help with [Troubleshooting ](http://gogs.io/docs/intro/troubleshooting.md ).
2015-03-18 06:00:55 -05:00
- Want to help with localization? Check out the [guide ](http://gogs.io/docs/features/i18n.html )!
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
2015-08-10 10:38:46 -05:00
- Account/Organization(with team)/Repository management
- Repository/Organization webhooks(including Slack)
- Repository Git hooks/deploy keys
2014-05-15 22:03:26 -05:00
- Add/remove repository collaborators
2015-08-10 10:38:46 -05:00
- Gravatar and custom source support
- Mail service
2014-05-15 22:03:26 -05:00
- Administration panel
2015-09-12 19:58:51 -05:00
- CI integration: [Drone ](https://github.com/drone/drone )
- Supports MySQL, PostgreSQL, SQLite3 and [TiDB ](https://github.com/pingcap/tidb )
2015-07-30 23:19:40 -05:00
- Multi-language support ([14 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
2015-07-07 00:51:28 -05:00
## Browser Support
2015-08-29 03:07:02 -05:00
- Please see [Semantic UI ](https://github.com/Semantic-Org/Semantic-UI#browser-support ) for specific versions of supported browsers.
- The official support minimal size is **1024*768** , UI may still looks right in smaller size but no promises and fixes.
2015-07-23 15:50:05 -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
2015-08-07 12:12:14 -05:00
### Tutorials
- [How To Set Up Gogs on Ubuntu 14.04 ](https://www.digitalocean.com/community/tutorials/how-to-set-up-gogs-on-ubuntu-14-04 )
2015-08-07 12:17:44 -05:00
- [Run your own GitHub-like service with the help of Docker ](http://blog.hypriot.com/post/run-your-own-github-like-service-with-docker/ )
- [阿里云上 Ubuntu 14.04 64 位安装 Gogs ](http://my.oschina.net/luyao/blog/375654 ) (Chinese)
- [Installing Gogs on FreeBSD ](https://www.codejam.info/2015/03/installing-gogs-on-freebsd.html )
- [Gogs on Raspberry Pi ](http://blog.meinside.pe.kr/Gogs-on-Raspberry-Pi/ )
2015-08-07 12:12:14 -05:00
2015-08-07 11:29:50 -05:00
### Screencasts
2015-08-16 10:49:38 -05:00
- [Instalando Gogs no Ubuntu ](http://blog.linuxpro.com.br/2015/08/14/instalando-gogs-no-ubuntu/ ) (Português)
2015-08-07 11:29:50 -05:00
2015-09-12 08:21:09 -05:00
### Deploy to Cloud
- [OpenShift ](https://github.com/tkisme/gogs-openshift )
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-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-07-28 08:24:24 -05:00
- Ex-team members [@lunny ](https://github.com/lunny ) and [@fuxiaohei ](https://github.com/fuxiaohei ).
2014-11-22 10:22:53 -05:00
- See [contributors page ](https://github.com/gogits/gogs/graphs/contributors ) for full list of contributors.
2015-09-04 04:54:22 -05:00
- See [TRANSLATORS ](conf/locale/TRANSLATORS ) for public 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.