gitea/README.md

Gogs - Go Git Service [![Build Status](https://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/gogs)
=====================

[![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)

![](public/img/gogs-large-resize.png)

##### Current version: 0.6.22 Beta

<table>
    <tr>
        <td width="33%"><img src="http://gogs.io/img/screenshots/1.png"></td>
        <td width="33%"><img src="http://gogs.io/img/screenshots/2.png"></td>
        <td width="33%"><img src="http://gogs.io/img/screenshots/3.png"></td>
    </tr>
    <tr>
        <td><img src="http://gogs.io/img/screenshots/4.png"></td>
        <td><img src="http://gogs.io/img/screenshots/5.png"></td>
        <td><img src="http://gogs.io/img/screenshots/6.png"></td>
    </tr>
    <tr>
        <td><img src="http://gogs.io/img/screenshots/7.png"></td>
        <td><img src="http://gogs.io/img/screenshots/8.png"></td>
        <td><img src="http://gogs.io/img/screenshots/9.png"></td>
    </tr>
</table>

### NOTICES

- 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.
- The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
- :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:
- If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!

#### Other language version

- [简体中文](README_ZH.md)

## Purpose

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, and Windows.

## Overview

- 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/gogs/gogs) or go down to the **Installation -> Install from binary** section!
- Having trouble? Get help with [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.html).
- Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!

## Features

- Activity timeline
- SSH and HTTP/HTTPS protocols
- SMTP/LDAP/Reverse proxy authentication
- Reverse proxy with sub-path
- Account/Organization/Repository management
- Repository/Organization webhooks (including Slack)
- Repository Git hooks/deploy keys
- Repository issues and pull requests
- Add/Remove repository collaborators
- Gravatar and custom source
- Mail service
- Administration panel
- CI integration: [Drone](https://github.com/drone/drone)
- Supports MySQL, PostgreSQL, SQLite3 and [TiDB](https://github.com/pingcap/tidb)
- Multi-language support ([14 languages](https://crowdin.com/project/gogs))

## System Requirements

- A cheap Raspberry Pi is powerful enough for basic functionality.
- At least 2 CPU cores and 1GB RAM would be the baseline for teamwork.

## Browser Support

- 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.

## Installation

Make sure you install the [prerequisites](http://gogs.io/docs/installation) first.

There are 5 ways to install Gogs:

- [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)
- [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)

### 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)
- [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/)

### Screencasts

- [Instalando Gogs no Ubuntu](http://blog.linuxpro.com.br/2015/08/14/instalando-gogs-no-ubuntu/) (Português)

### Deploy to Cloud

- [OpenShift](https://github.com/tkisme/gogs-openshift)
- [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
- [Scaleway](https://www.scaleway.com/imagehub/gogs/)
- [Portal](https://portaldemo.xyz/cloud/)
- [Sandstorm](https://github.com/cem/gogs-sandstorm)

### Product Support

- [Synology](https://www.synology.com) (Docker)
- [One Space](http://www.onespace.cc) (App Store)

## Acknowledgments

- Router and middleware mechanism of [Macaron](https://github.com/go-macaron/macaron).
- Modules design is inspired by [WeTalk](https://github.com/beego/wetalk).
- System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.

## Contributors

- Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
- See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
- See [TRANSLATORS](conf/locale/TRANSLATORS) for public list of translators.

## License

This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.
conf/locale: add Japanese support README: remove duplicated travis badge 2015-02-01 18:36:40 +00:00			`Gogs - Go Git Service [![Build Status](https://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/gogs)`
Add comment of issue 2014-03-26 16:31:01 +00:00			`=====================`

Added Gitter badge 2014-12-21 07:53:06 +00: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)`

#1622 comment with whitespace 2015-09-12 20:58:18 +00:00			`![](public/img/gogs-large-resize.png)`
Mirror fix 2014-03-15 14:29:18 +00:00
fix #1078 2015-11-03 00:55:24 +00:00			`##### Current version: 0.6.22 Beta`
Update README 2014-03-13 06:55:14 +00:00
Update README screenshots 2015-08-15 17:41:11 +00:00			`<table>`
			`<tr>`
fix link again 2015-10-01 05:58:59 +00:00			`<td width="33%"><img src="http://gogs.io/img/screenshots/1.png"></td>`
			`<td width="33%"><img src="http://gogs.io/img/screenshots/2.png"></td>`
			`<td width="33%"><img src="http://gogs.io/img/screenshots/3.png"></td>`
Update README screenshots 2015-08-15 17:41:11 +00:00			`</tr>`
			`<tr>`
fix link again 2015-10-01 05:58:59 +00:00			`<td><img src="http://gogs.io/img/screenshots/4.png"></td>`
			`<td><img src="http://gogs.io/img/screenshots/5.png"></td>`
			`<td><img src="http://gogs.io/img/screenshots/6.png"></td>`
Update README screenshots 2015-08-15 17:41:11 +00:00			`</tr>`
			`<tr>`
fix link again 2015-10-01 05:58:59 +00:00			`<td><img src="http://gogs.io/img/screenshots/7.png"></td>`
			`<td><img src="http://gogs.io/img/screenshots/8.png"></td>`
			`<td><img src="http://gogs.io/img/screenshots/9.png"></td>`
Update README screenshots 2015-08-15 17:41:11 +00:00			`</tr>`
			`</table>`

Able to change mirror interval now 2014-04-13 02:30:00 +00:00			`### NOTICES`

update link 2015-01-27 21:30:58 +00: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.`
prepare for 0.6 release 2015-03-18 11:00:55 +00:00			- The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
update README 2015-09-01 10:34:14 +00: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:`
Update notice 2015-03-19 03:20:41 +00:00			`- If you think there are vulnerabilities in the project, please talk privately to u@gogs.io. Thanks!`
Mirror fix and update 2014-03-29 14:01:52 +00:00
Fix action 2014-03-23 10:27:01 +00:00			`#### Other language version`

			`- [简体中文](README_ZH.md)`
Update README 2014-03-23 00:25:39 +00:00
Init commit 2014-02-12 17:49:46 +00:00			`## Purpose`

update locales 2015-10-02 06:55:52 +00: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, and Windows.`
Init commit 2014-02-12 17:49:46 +00:00
Formatting 2014-02-14 23:16:54 +00:00			`## Overview`

Fixed broken link in README The link http://gogs.io/docs/intro/ produces a 404 error and is used in the README updated it to http://gogs.io/docs/intro which correctly links to the introductory documentation 2015-10-29 19:34:59 +00:00			`- Please see the [Documentation](http://gogs.io/docs/intro) for project design, known issues, and change log.`
Fix a bunch of small typos and formatting quirks 2015-02-14 20:31:07 +00:00			`- See the [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.`
fix README 2015-09-03 21:25:33 +00: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!`
fix README links 2015-10-09 19:41:08 +00:00			`- Having trouble? Get help with [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.html).`
prepare for 0.6 release 2015-03-18 11:00:55 +00:00			`- Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!`
Formatting 2014-02-14 23:16:54 +00:00
Add gopmfile 2014-03-11 23:25:50 +00:00			`## Features`

Clean code 2014-03-16 06:28:24 +00:00			`- Activity timeline`
update README 2015-10-25 07:30:16 +00: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)`
update README 2015-08-10 15:38:46 +00:00			`- Repository Git hooks/deploy keys`
update README 2015-10-25 07:30:16 +00:00			`- Repository issues and pull requests`
			`- Add/Remove repository collaborators`
			`- Gravatar and custom source`
update README 2015-08-10 15:38:46 +00:00			`- Mail service`
Clean old LDAP code 2014-05-16 03:03:26 +00:00			`- Administration panel`
#1625 remove auto_register and makes it default 2015-09-13 00:58:51 +00:00			`- CI integration: [Drone](https://github.com/drone/drone)`
			`- Supports MySQL, PostgreSQL, SQLite3 and [TiDB](https://github.com/pingcap/tidb)`
add italian support 2015-07-31 04:19:40 +00:00			`- Multi-language support ([14 languages](https://crowdin.com/project/gogs))`
Add gopmfile 2014-03-11 23:25:50 +00:00
Fix #102 2014-04-26 07:22:22 +00:00			`## System Requirements`

Fix a bunch of small typos and formatting quirks 2015-02-14 20:31:07 +00:00			`- A cheap Raspberry Pi is powerful enough for basic functionality.`
models: fix issue with transfer repository README: fix typo 2015-02-24 05:27:22 +00:00			`- At least 2 CPU cores and 1GB RAM would be the baseline for teamwork.`
Fix #102 2014-04-26 07:22:22 +00:00
update UI framework 2015-07-07 05:51:28 +00:00			`## Browser Support`

#1544 Creating new repository fails occasionally 2015-08-29 08:07:02 +00: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 *1024768**, UI may still looks right in smaller size but no promises and fixes.`
UI: issues - finish basic frame 2015-07-23 20:50:05 +00:00
Formatting 2014-02-14 23:16:54 +00:00			`## Installation`

Reopen PR need retest patch 2015-10-25 07:10:22 +00:00			`Make sure you install the [prerequisites](http://gogs.io/docs/installation) first.`
Bug fix 2014-03-12 04:19:45 +00:00
Fix edit auth page bug 2014-05-12 15:02:36 +00:00			`There are 5 ways to install Gogs:`
Formatting 2014-02-14 23:16:54 +00:00
fix README links 2015-10-09 19:41:08 +00: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)`
Fix #348 2014-09-05 21:28:09 +00:00			`- [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)`
Mirror fix on UI 2014-05-02 23:23:06 +00:00			`- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)`
Formatting 2014-02-14 23:16:54 +00:00
update README 2015-08-07 17:12:14 +00: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)`
add more tutorial links 2015-08-07 17:17:44 +00: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/)`
update README 2015-08-07 17:12:14 +00:00
fix #1367 2015-08-07 16:29:50 +00:00			`### Screencasts`

fix #1491 2015-08-16 15:49:38 +00:00			`- [Instalando Gogs no Ubuntu](http://blog.linuxpro.com.br/2015/08/14/instalando-gogs-no-ubuntu/) (Português)`
fix #1367 2015-08-07 16:29:50 +00:00
typo and README 2015-09-12 13:21:09 +00:00			`### Deploy to Cloud`

			`- [OpenShift](https://github.com/tkisme/gogs-openshift)`
#1693 minor fix 2015-09-25 23:07:21 +00:00			`- [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)`
			`- [Scaleway](https://www.scaleway.com/imagehub/gogs/)`
save PR info as patch and minor fix on PR 2015-10-05 00:54:06 +00:00			`- [Portal](https://portaldemo.xyz/cloud/)`
update README 2015-10-29 07:21:59 +00:00			`- [Sandstorm](https://github.com/cem/gogs-sandstorm)`

			`### Product Support`

			`- [Synology](https://www.synology.com) (Docker)`
			`- [One Space](http://www.onespace.cc) (App Store)`
typo and README 2015-09-12 13:21:09 +00:00
Init commit 2014-02-12 17:49:46 +00:00			`## Acknowledgments`

Reopen PR need retest patch 2015-10-25 07:10:22 +00:00			`- Router and middleware mechanism of [Macaron](https://github.com/go-macaron/macaron).`
			`- Modules design is inspired by [WeTalk](https://github.com/beego/wetalk).`
Batch updates 2014-03-22 21:59:22 +00:00			`- System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).`
Mirror changes 2014-04-30 07:44:28 +00:00			`- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.`
test drone 2014-11-17 22:19:17 +00:00			`- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.`
Init commit 2014-02-12 17:49:46 +00:00
			`## Contributors`

update README 2015-10-25 07:30:16 +00:00			`- Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).`
Fix 653 2014-11-22 15:22:53 +00:00			`- See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.`
#1577 explore paginator problem 2015-09-04 09:54:22 +00:00			`- See [TRANSLATORS](conf/locale/TRANSLATORS) for public list of translators.`
add the license section under the README.md file It's very clear if we add the license type in the README.md 2014-03-27 16:34:12 +00:00
			`## License`

Code convention 2014-05-24 19:28:31 +00: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.`