2015-12-07 19:40:24 -05:00
Gogs - Go Git Service [![Build Status ](https://travis-ci.org/gogits/gogs.svg?branch=master )](https://travis-ci.org/gogits/gogs) [![Docker Repository on Quay ](https://quay.io/repository/gogs/gogs/status "Docker Repository on Quay" )](https://quay.io/repository/gogs/gogs)
2014-03-26 12:31:01 -04: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 16:58:18 -04:00
![](public/img/gogs-large-resize.png)
2014-03-15 10:29:18 -04:00
2015-12-05 17:39:29 -05:00
##### Current version: 0.7.33 Beta
2014-03-13 02:55:14 -04:00
2015-12-05 13:50:43 -05:00
| Web | UI | Preview |
|:-------------:|:-------:|:-------:|
|![Dashboard](https://gogs.io/img/screenshots/1.png)|![Repository](https://gogs.io/img/screenshots/2.png)|![Commits History](https://gogs.io/img/screenshots/3.png)|
|![Profile](https://gogs.io/img/screenshots/4.png)|![Admin Dashboard](https://gogs.io/img/screenshots/5.png)|![Diff](https://gogs.io/img/screenshots/6.png)|
|![Issues](https://gogs.io/img/screenshots/7.png)|![Releases](https://gogs.io/img/screenshots/8.png)|![Organization](https://gogs.io/img/screenshots/9.png)|
2015-08-15 13:41:11 -04:00
2014-04-12 22:30:00 -04: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 07:00:55 -04:00
- The demo site [try.gogs.io ](https://try.gogs.io ) is running under `develop` branch.
2015-11-20 11:37:17 -05:00
- :bangbang:< 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, otherwise it's high possibilities that we are not going to merge it.</ span > :bangbang:
- Please [start discussion ](http://forum.gogs.io/category/2/general-discussion ) or [ask a question ](http://forum.gogs.io/category/4/getting-help ) on [the forum ](http://forum.gogs.io/ ). GitHub issue tracker only keeps **bugs** and **feature requests** , all other topics will be closed without reason.
2015-03-18 23:20:41 -04:00
- If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io** . Thanks!
2015-11-07 20:20:51 -05:00
- If you're interested in using APIs, we have experimental support with [documentation ](https://github.com/gogits/go-gogs-client/wiki ).
- If your team/company is using Gogs and would like to put your logo on [our website ](http://gogs.io ), contact us by any means.
2014-03-29 10:01:52 -04:00
2015-11-07 20:20:51 -05:00
[简体中文 ](README_ZH.md )
2014-03-22 20:25:39 -04:00
2014-02-12 12:49:46 -05:00
## Purpose
2015-11-04 18:34:08 -05:00
The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across **ALL platforms** that Go supports, including Linux, Mac OS X, Windows and ARM.
2014-02-12 12:49:46 -05:00
2014-02-14 18:16:54 -05:00
## Overview
2015-11-04 21:57:10 -05:00
- Please see the [Documentation ](http://gogs.io/docs/intro ) for common usages and change log.
2015-02-14 15:31:07 -05:00
- See the [Trello Board ](https://trello.com/b/uxAoeLUl/gogs-go-git-service ) to follow the develop team.
2015-12-06 15:34:17 -05:00
- Want to try it before doing anything else? Do it [online ](https://try.gogs.io/gogs/gogs )!
2015-10-09 15:41:08 -04:00
- Having trouble? Get help with [Troubleshooting ](http://gogs.io/docs/intro/troubleshooting.html ).
2015-03-18 07:00:55 -04: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 19:25:50 -04:00
## Features
2014-03-16 02:28:24 -04:00
- Activity timeline
2015-10-25 03:30:16 -04:00
- SSH and HTTP/HTTPS protocols
- SMTP/LDAP/Reverse proxy authentication
- Reverse proxy with sub-path
- Account/Organization/Repository management
- Repository/Organization webhooks (including Slack)
2015-08-10 11:38:46 -04:00
- Repository Git hooks/deploy keys
2015-12-06 23:07:02 -05:00
- Repository issues, pull requests and wiki
2015-10-25 03:30:16 -04:00
- Add/Remove repository collaborators
- Gravatar and custom source
2015-08-10 11:38:46 -04:00
- Mail service
2014-05-15 23:03:26 -04:00
- Administration panel
2015-11-04 21:57:10 -05:00
- Supports MySQL, PostgreSQL, SQLite3 and [TiDB ](https://github.com/pingcap/tidb ) (experimental)
2015-07-31 00:19:40 -04:00
- Multi-language support ([14 languages](https://crowdin.com/project/gogs))
2014-03-11 19:25:50 -04:00
2014-04-26 03:22:22 -04:00
## System Requirements
2015-02-14 15:31:07 -05:00
- A cheap Raspberry Pi is powerful enough for basic functionality.
2015-11-07 20:20:51 -05:00
- 2 CPU cores and 1GB RAM would be the baseline for teamwork.
2014-04-26 03:22:22 -04:00
2015-07-07 01:51:28 -04:00
## Browser Support
2015-08-29 04:07:02 -04: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 16:50:05 -04:00
2014-02-14 18:16:54 -05:00
## Installation
2015-10-25 03:10:22 -04:00
Make sure you install the [prerequisites ](http://gogs.io/docs/installation ) first.
2014-03-12 00:19:45 -04:00
2014-05-12 11:02:36 -04:00
There are 5 ways to install Gogs:
2014-02-14 18:16:54 -05:00
2015-10-09 15:41:08 -04:00
- [Install from binary ](http://gogs.io/docs/installation/install_from_binary.html )
- [Install from source ](http://gogs.io/docs/installation/install_from_source.html )
- [Install from packages ](http://gogs.io/docs/installation/install_from_packages.html )
2014-09-05 17:28:09 -04:00
- [Ship with Docker ](https://github.com/gogits/gogs/tree/master/docker )
2014-05-02 19:23:06 -04: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 13:12:14 -04: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 13:17:44 -04: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/ )
2015-11-09 11:34:04 -05:00
- [使用 Gogs 搭建自己的 Git 服务器 ](https://mynook.info/blog/post/host-your-own-git-server-using-gogs ) (Chinese)
2015-08-07 13:17:44 -04:00
- [阿里云上 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 13:12:14 -04:00
2015-08-07 12:29:50 -04:00
### Screencasts
2015-08-16 11:49:38 -04:00
- [Instalando Gogs no Ubuntu ](http://blog.linuxpro.com.br/2015/08/14/instalando-gogs-no-ubuntu/ ) (Português)
2015-08-07 12:29:50 -04:00
2015-09-12 09:21:09 -04:00
### Deploy to Cloud
- [OpenShift ](https://github.com/tkisme/gogs-openshift )
2015-09-25 19:07:21 -04:00
- [Cloudron ](https://cloudron.io/appstore.html#io.gogs.cloudronapp )
- [Scaleway ](https://www.scaleway.com/imagehub/gogs/ )
2015-10-04 20:54:06 -04:00
- [Portal ](https://portaldemo.xyz/cloud/ )
2015-10-29 03:21:59 -04:00
- [Sandstorm ](https://github.com/cem/gogs-sandstorm )
2015-12-01 19:53:19 -05:00
- [sloppy.io ](https://github.com/sloppyio/quickstarters/tree/master/gogs )
2015-10-29 03:21:59 -04:00
2015-12-05 13:50:43 -05:00
## Software and Service Support
- [Drone ](https://github.com/drone/drone ) (CI)
- [Fabric8 ](http://fabric8.io/ ) (DevOps)
- [Taiga ](https://taiga.io/ ) (Project Management)
2015-10-29 03:21:59 -04:00
### Product Support
- [Synology ](https://www.synology.com ) (Docker)
- [One Space ](http://www.onespace.cc ) (App Store)
2015-09-12 09:21:09 -04:00
2014-02-12 12:49:46 -05:00
## Acknowledgments
2015-10-25 03:10:22 -04:00
- Router and middleware mechanism of [Macaron ](https://github.com/go-macaron/macaron ).
- Modules design is inspired by [WeTalk ](https://github.com/beego/wetalk ).
2014-03-22 17:59:22 -04:00
- System Monitor Status is inspired by [GoBlog ](https://github.com/fuxiaohei/goblog ).
2014-04-30 03:44:28 -04: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.
2015-11-05 14:40:22 -05:00
- Thanks [DigitalOcean ](https://www.digitalocean.com ) for hosting home and demo sites.
2014-02-12 12:49:46 -05:00
## Contributors
2015-10-25 03:30:16 -04:00
- Ex-team members [@lunny ](https://github.com/lunny ), [@fuxiaohei ](https://github.com/fuxiaohei ) and [@slene ](https://github.com/slene ).
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 05:54:22 -04:00
- See [TRANSLATORS ](conf/locale/TRANSLATORS ) for public list of translators.
2014-03-27 12:34:12 -04:00
## License
2014-05-24 15:28:31 -04: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.