forgejo/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)

Gogs (Go Git Service) is a painless self-hosted Git service.

![Demo](http://gogs.qiniudn.com/gogs_demo.gif)

##### Current version: 0.6.0 Beta

### 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.
- 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 Reuqests, otherwise it's high possibilities that we are not going to merge it.
- 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 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.

## 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/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 the [guide](http://gogs.io/docs/features/i18n.html)!

## Features

- Activity timeline
- SSH/HTTP(S) protocol support
- SMTP/LDAP/reverse proxy authentication support
- Reverse proxy suburl support
- Register/delete/rename account
- Create/manage/delete organization with team management
- Create/fork/migrate/mirror/delete/watch/rename/transfer public/private repository
- Repository viewer/release/issue tracker
- Repository and Organization level webhooks
- Repository Git hooks
- Add/remove repository collaborators
- Gravatar and cache support
- Mail service (register, issue)
- Administration panel
- Slack webhook integration
- Drone CI integration
- Supports MySQL, PostgreSQL and SQLite3
- Social account login (GitHub, Google, QQ, Weibo)
- Multi-language support ([11 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.

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

## Acknowledgments

- Router and middleware mechanism of [Macaron](https://github.com/Unknwon/macaron).
- 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).
- 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.
- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.

## 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.
- See [TRANSLATORS](conf/locale/TRANSLATORS) for full 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 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)`
Add comment of issue 2014-03-26 12:31:01 -04:00			`=====================`

Added Gitter badge 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)`

add sr-only class, change to new tag line 2015-03-20 03:20:05 -04:00			`Gogs (Go Git Service) is a painless self-hosted Git service.`
Mirror fix 2014-03-15 10:29:18 -04:00
update link 2015-01-27 16:30:58 -05:00			`![Demo](http://gogs.qiniudn.com/gogs_demo.gif)`
Init commit 2014-02-12 12:49:46 -05:00
prepare for 0.6 release 2015-03-18 07:00:55 -04:00			`##### Current version: 0.6.0 Beta`
Update README 2014-03-13 02:55:14 -04:00
Able to change mirror interval now 2014-04-12 22:30:00 -04:00			`### NOTICES`

update link 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.`
prepare for 0.6 release 2015-03-18 07:00:55 -04:00			- The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
Update notice 2015-03-18 23:20:41 -04:00			`- 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 Reuqests, otherwise it's high possibilities that we are not going to merge it.`
			`- If you think there are vulnerabilities in the project, please talk privately to u@gogs.io. Thanks!`
Mirror fix and update 2014-03-29 10:01:52 -04:00
Fix action 2014-03-23 06:27:01 -04:00			`#### Other language version`

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

Fix a bunch of small typos and formatting quirks 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.`
Init commit 2014-02-12 12:49:46 -05:00
Formatting 2014-02-14 18:16:54 -05:00			`## Overview`

Fix a bunch of small typos and formatting quirks 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).`
prepare for 0.6 release 2015-03-18 07:00:55 -04:00			`- Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!`
Formatting 2014-02-14 18:16:54 -05:00
Add gopmfile 2014-03-11 19:25:50 -04:00			`## Features`

Clean code 2014-03-16 02:28:24 -04:00			`- Activity timeline`
Clean old LDAP code 2014-05-15 23:03:26 -04:00			`- SSH/HTTP(S) protocol support`
Clean files 2014-06-21 17:57:59 -04:00			`- SMTP/LDAP/reverse proxy authentication support`
Page: Compare 2 commits 2014-10-10 21:40:51 -04:00			`- Reverse proxy suburl support`
Clean old LDAP code 2014-05-15 23:03:26 -04:00			`- Register/delete/rename account`
Finish new admin users pages 2014-08-29 03:32:52 -04:00			`- Create/manage/delete organization with team management`
Work on #5 fork and fix #608 2014-11-05 23:30:04 -05:00			`- Create/fork/migrate/mirror/delete/watch/rename/transfer public/private repository`
Organization level webhooks 2014-09-07 19:39:26 -04:00			`- Repository viewer/release/issue tracker`
			`- Repository and Organization level webhooks`
Add raw, history file button, and other mirror fixes 2014-10-11 18:02:48 -04:00			`- Repository Git hooks`
Clean old LDAP code 2014-05-15 23:03:26 -04:00			`- Add/remove repository collaborators`
			`- Gravatar and cache support`
Fix a bunch of small typos and formatting quirks 2015-02-14 15:31:07 -05:00			`- Mail service (register, issue)`
Clean old LDAP code 2014-05-15 23:03:26 -04:00			`- Administration panel`
update docs and mirror bug fix 2014-09-02 07:11:39 -04:00			`- Slack webhook integration`
quick fix 2014-11-17 16:29:23 -05:00			`- Drone CI integration`
Clean old LDAP code 2014-05-15 23:03:26 -04:00			`- Supports MySQL, PostgreSQL and SQLite3`
Fix a bunch of small typos and formatting quirks 2015-02-14 15:31:07 -05:00			`- Social account login (GitHub, Google, QQ, Weibo)`
#1050: Bad permissions on authorized_keys after rewrite 2015-03-14 22:37:23 -04:00			`- Multi-language support ([11 languages](https://crowdin.com/project/gogs))`
Add gopmfile 2014-03-11 19:25:50 -04:00
Fix #102 2014-04-26 03:22:22 -04:00			`## System Requirements`

Fix a bunch of small typos and formatting quirks 2015-02-14 15:31:07 -05:00			`- A cheap Raspberry Pi is powerful enough for basic functionality.`
models: fix issue with transfer repository README: fix typo 2015-02-24 00:27:22 -05:00			`- At least 2 CPU cores and 1GB RAM would be the baseline for teamwork.`
Fix #102 2014-04-26 03:22:22 -04:00
Formatting 2014-02-14 18:16:54 -05:00			`## Installation`

Fix a bunch of small typos and formatting quirks 2015-02-14 15:31:07 -05:00			`Make sure you install the [prerequisites](http://gogs.io/docs/installation/) first.`
Bug fix 2014-03-12 00:19:45 -04:00
Fix edit auth page bug 2014-05-12 11:02:36 -04:00			`There are 5 ways to install Gogs:`
Formatting 2014-02-14 18:16:54 -05:00
Hide org member in collar page 2014-10-10 06:15:27 -04:00			`- [Install from binary](http://gogs.io/docs/installation/install_from_binary.md)`
Clean files 2014-05-01 03:27:26 -04:00			`- [Install from source](http://gogs.io/docs/installation/install_from_source.md)`
Fix edit auth page bug 2014-05-12 11:02:36 -04:00			`- [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)`
Fix #348 2014-09-05 17:28:09 -04:00			`- [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)`
Mirror fix on UI 2014-05-02 19:23:06 -04:00			`- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)`
Formatting 2014-02-14 18:16:54 -05:00
Init commit 2014-02-12 12:49:46 -05:00			`## Acknowledgments`

UI: Confirmation box 2014-09-29 18:52:28 -04:00			`- Router and middleware mechanism of [Macaron](https://github.com/Unknwon/macaron).`
Batch updates 2014-03-22 17:59:22 -04: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 changes 2014-04-30 03:44:28 -04:00			`- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.`
Update README 2014-03-24 11:44:47 -04:00			`- Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.`
test drone 2014-11-17 17:19:17 -05:00			`- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.`
Init commit 2014-02-12 12:49:46 -05:00
			`## Contributors`

update README notice and CONTRIBUTING.md 2015-02-07 11:09:17 -05:00			`- The [core team](http://gogs.io/team) of this project.`
Fix 653 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.`
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 12:34:12 -04:00
			`## License`

Code convention 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.`