84 lines
4 KiB
Markdown
84 lines
4 KiB
Markdown
Gogs - Go Git Service [](https://app.wercker.com/project/bykey/ad0bdb0bc450ac6f09bc56b9640a50aa) [](https://travis-ci.org/gogits/gogs)
|
|
=====================
|
|
|
|
Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.
|
|
|
|
|
|
|
|
##### Current version: 0.5.5 Beta
|
|
|
|
### NOTICES
|
|
|
|
- Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) 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.gogs.io](https://try.gogs.io) is running under `dev` branch.
|
|
|
|
#### 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 in independent binary distribution across **ALL platforms** that Go supports, including Linux, Mac OS X, and Windows.
|
|
|
|
## 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](https://try.gogs.io/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
|
|
- Reverse proxy suburl support
|
|
- Register/delete/rename account
|
|
- Create/manage/delete organization with team management
|
|
- Create/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
|
|
- Supports MySQL, PostgreSQL and SQLite3
|
|
- Social account login(GitHub, Google, QQ, Weibo)
|
|
- Multi-language support(English, Simplified Chinese, Traditional Chinese, Germany, French, Dutch, and [more](https://crowdin.com/project/gogs))
|
|
|
|
## 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)
|
|
- [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).
|
|
- 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.
|
|
- Thanks to [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.
|
|
|
|
## 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.
|