gitea/README.md

Gogs - Go Git Service [![wercker status](https://app.wercker.com/status/ad0bdb0bc450ac6f09bc56b9640a50aa/s/ "wercker status")](https://app.wercker.com/project/bykey/ad0bdb0bc450ac6f09bc56b9640a50aa) [![Build Status](https://drone.io/github.com/gogits/gogs/status.png)](https://drone.io/github.com/gogits/gogs/latest)
=====================

Gogs(Go Git Service) is a Self Hosted Git Service in the Go Programming Language.

![Demo](http://gowalker.org/public/gogs_demo.gif)

##### Current version: 0.4.5 Alpha

### NOTICES

- Due to testing purpose, data of [try.gogits.org](http://try.gogits.org) has been reset in **June 21, 2014** and will reset multiple times after. Please do **NOT** put your important data on the site.
- Demo site [try.gogits.org](http://try.gogits.org) is running under `dev` branch.

#### Other language version

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

## Purpose

Since we choose to use pure Go implementation of Git manipulation, Gogs certainly supports **ALL platforms**  that Go supports, including Linux, Mac OS X, and Windows with **ZERO** dependency. 

More importantly, Gogs only needs one binary to setup your own project hosting on the fly!

## Overview

- Please see [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.
- See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
- Try it before anything? Do it [online](http://try.gogits.org/Unknown/gogs) or go down to **Installation -> Install from binary** section!
- Having troubles? Get help from [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).

## Features

- Activity timeline
- SSH/HTTP(S) protocol support
- SMTP/LDAP/reverse proxy authentication support
- Register/delete/rename account
- Create/migrate/mirror/delete/watch/rename/transfer public/private repository
- Repository viewer/release/issue tracker/webhooks
- Add/remove repository collaborators
- Gravatar and cache support
- Mail service(register, issue)
- Administration panel
- Supports MySQL, PostgreSQL and SQLite3
- Social account login(GitHub, Google, QQ, Weibo)

## System Requirements

- A cheap Raspberry Pi is powerful enough to match the minimal requirement.
- 4 CPU Cores and 1GB RAM would be the baseline for teamwork.

## Installation

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

There are 5 ways to install Gogs:

- [Install from binary](http://gogs.io/docs/installation/install_from_binary.md): **STRONGLY RECOMMENDED**
- [Install from source](http://gogs.io/docs/installation/install_from_source.md)
- [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)
- [Ship with Docker](https://github.com/gogits/gogs/tree/master/dockerfiles)
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)

## Acknowledgments

- Router and middleware mechanism of [martini](http://martini.codegangsta.io/).
- 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).
- Usage and modification from [beego](http://beego.me) modules.
- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
- Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
- Great thanks to [Docker China](http://www.dockboard.org/) for providing [dockerfiles](https://github.com/gogits/gogs/tree/master/dockerfiles).

## Contributors

The [core team](http://gogs.io/team) of this project. See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.

## 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.
Add comment of issue 2014-03-27 00:31:01 +08:00			`Gogs - Go Git Service [![wercker status](https://app.wercker.com/status/ad0bdb0bc450ac6f09bc56b9640a50aa/s/ "wercker status")](https://app.wercker.com/project/bykey/ad0bdb0bc450ac6f09bc56b9640a50aa) [![Build Status](https://drone.io/github.com/gogits/gogs/status.png)](https://drone.io/github.com/gogits/gogs/latest)`
			`=====================`

Update README 2014-03-23 08:25:39 +08:00			`Gogs(Go Git Service) is a Self Hosted Git Service in the Go Programming Language.`
Mirror fix 2014-03-15 22:29:18 +08:00
Update README 2014-03-23 08:25:39 +08:00			`![Demo](http://gowalker.org/public/gogs_demo.gif)`
Init commit 2014-02-13 01:49:46 +08:00
Clean files 2014-06-22 05:57:59 +08:00			`##### Current version: 0.4.5 Alpha`
Update README 2014-03-13 14:55:14 +08:00
Able to change mirror interval now 2014-04-13 10:30:00 +08:00			`### NOTICES`

Clean files 2014-06-22 05:57:59 +08:00			`- Due to testing purpose, data of [try.gogits.org](http://try.gogits.org) has been reset in June 21, 2014 and will reset multiple times after. Please do NOT put your important data on the site.`
Able to change mirror interval now 2014-04-13 10:30:00 +08:00			- Demo site [try.gogits.org](http://try.gogits.org) is running under `dev` branch.
Mirror fix and update 2014-03-29 22:01:52 +08:00
Fix action 2014-03-23 18:27:01 +08:00			`#### Other language version`

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

Update README 2014-03-23 08:25:39 +08:00			`Since we choose to use pure Go implementation of Git manipulation, Gogs certainly supports ALL platforms that Go supports, including Linux, Mac OS X, and Windows with ZERO dependency.`

			`More importantly, Gogs only needs one binary to setup your own project hosting on the fly!`
Init commit 2014-02-13 01:49:46 +08:00
Formatting 2014-02-15 07:16:54 +08:00			`## Overview`

Clean files 2014-05-01 15:27:26 +08:00			`- Please see [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.`
fix typo s/Broad/Board 2014-03-26 03:12:23 +08:00			`- See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.`
Basic admin data table, models changes 2014-03-21 04:04:56 +08:00			`- Try it before anything? Do it [online](http://try.gogits.org/Unknown/gogs) or go down to Installation -> Install from binary section!`
Clean files 2014-05-01 15:27:26 +08:00			`- Having troubles? Get help from [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).`
Formatting 2014-02-15 07:16:54 +08:00
Add gopmfile 2014-03-12 07:25:50 +08:00			`## Features`

Clean code 2014-03-16 14:28:24 +08:00			`- Activity timeline`
Clean old LDAP code 2014-05-16 11:03:26 +08:00			`- SSH/HTTP(S) protocol support`
Clean files 2014-06-22 05:57:59 +08:00			`- SMTP/LDAP/reverse proxy authentication support`
Clean old LDAP code 2014-05-16 11:03:26 +08:00			`- Register/delete/rename account`
			`- Create/migrate/mirror/delete/watch/rename/transfer public/private repository`
			`- Repository viewer/release/issue tracker/webhooks`
			`- Add/remove repository collaborators`
			`- Gravatar and cache support`
			`- Mail service(register, issue)`
			`- Administration panel`
			`- Supports MySQL, PostgreSQL and SQLite3`
Add weibo oauth 2014-04-14 09:00:12 +08:00			`- Social account login(GitHub, Google, QQ, Weibo)`
Add gopmfile 2014-03-12 07:25:50 +08:00
Fix #102 2014-04-26 15:22:22 +08:00			`## System Requirements`

			`- A cheap Raspberry Pi is powerful enough to match the minimal requirement.`
			`- 4 CPU Cores and 1GB RAM would be the baseline for teamwork.`

Formatting 2014-02-15 07:16:54 +08:00			`## Installation`

Clean files 2014-05-01 15:27:26 +08:00			`Make sure you install [Prerequirements](http://gogs.io/docs/installation/) first.`
Bug fix 2014-03-12 12:19:45 +08:00
Fix edit auth page bug 2014-05-12 23:02:36 +08:00			`There are 5 ways to install Gogs:`
Formatting 2014-02-15 07:16:54 +08:00
Clean files 2014-05-01 15:27:26 +08:00			`- [Install from binary](http://gogs.io/docs/installation/install_from_binary.md): STRONGLY RECOMMENDED`
			`- [Install from source](http://gogs.io/docs/installation/install_from_source.md)`
Fix edit auth page bug 2014-05-12 23:02:36 +08:00			`- [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)`
UPDATE README 2014-04-12 00:26:23 +08:00			`- [Ship with Docker](https://github.com/gogits/gogs/tree/master/dockerfiles)`
Mirror fix on UI 2014-05-03 07:23:06 +08:00			`- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)`
Formatting 2014-02-15 07:16:54 +08:00
Init commit 2014-02-13 01:49:46 +08:00			`## Acknowledgments`

Mirror fix 2014-03-24 19:36:38 +08:00			`- Router and middleware mechanism of [martini](http://martini.codegangsta.io/).`
Batch updates 2014-03-23 05:59:22 +08: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).`
Mirror fix 2014-03-24 19:36:38 +08:00			`- Usage and modification from [beego](http://beego.me) modules.`
Mirror changes 2014-04-30 15:44:28 +08:00			`- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.`
Update README 2014-03-24 23:44:47 +08:00			`- Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.`
UPDATE README 2014-04-12 00:26:23 +08:00			`- Great thanks to [Docker China](http://www.dockboard.org/) for providing [dockerfiles](https://github.com/gogits/gogs/tree/master/dockerfiles).`
Init commit 2014-02-13 01:49:46 +08:00
			`## Contributors`

Add mail notify for new collaborator 2014-05-05 16:27:28 +08:00			`The [core team](http://gogs.io/team) of this project. See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.`
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-28 00:34:12 +08:00
			`## License`

Code convention 2014-05-25 03:28:31 +08: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.`