gogs/README.md

Gogs - Go Git Service

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

Current version: 0.2.9 Alpha

NOTICES

• Due to testing purpose, data of try.gogits.org has been reset in April 6, 2014 and will reset multiple times after. Please do NOT put your important data on the site.
• Demo site try.gogits.org is running under dev branch.

Other language version

• 简体中文

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 Wiki for project design, known issues, change log and road map.
• See Trello Board to follow the develop team.
• Try it before anything? Do it online or go down to Installation -> Install from binary section!
• Having troubles? Get help from Troubleshooting.

Features

• Activity timeline
• SSH/HTTP(S) protocol support.
• Register/delete/rename account.
• Create/migrate/mirror/delete/watch/rename/transfer public/private repository.
• Repository viewer/issue tracker.
• Gravatar and cache support.
• Mail service(register, issue).
• Administration panel.
• Supports MySQL, PostgreSQL and SQLite3.
• Social account login(GitHub, Google, QQ, Weibo)

Installation

Make sure you install Prerequirements first.

There are 3 ways to install Gogs:

• Install from binary: STRONGLY RECOMMENDED
• Install from source
• Ship with Docker

Acknowledgments

• Logo is inspired by martini-contrib.
• Router and middleware mechanism of martini.
• Mail Service, modules design is inspired by WeTalk.
• System Monitor Status is inspired by GoBlog.
• Usage and modification from beego modules.
• Thanks gobuild.io for providing binary compile and download service.
• Great thanks to Docker China for providing dockerfiles.

Contributors

This project was launched by Unknown and lunny; fuxiaohei, slene and skyblue joined the team soon after. See contributors page for full list of contributors.

License

Gogs is under the MIT License. See the LICENSE file for the full license text.