gitea/README.md

91 lines
4.1 KiB
Markdown
Raw Normal View History

Gogs - Go Git Service [![Build Status](https://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/gogs)
2014-03-26 10:31:01 -06:00
=====================
2014-12-21 00:53:06 -07: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)
2014-07-26 01:02:46 -06:00
Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.
2014-03-15 08:29:18 -06:00
2015-01-27 14:30:58 -07:00
![Demo](http://gogs.qiniudn.com/gogs_demo.gif)
2014-02-12 10:49:46 -07:00
##### Current version: 0.5.12 Beta
2014-03-13 00:55:14 -06:00
2014-04-12 20:30:00 -06:00
### NOTICES
2015-01-27 14:30:58 -07: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.
2014-09-15 15:23:58 -06:00
- Demo site [try.gogs.io](https://try.gogs.io) is running under `dev` branch.
- If you think there are vulnerabilities in the project, please talk private to **u@gogs.io**, thanks!
2014-03-29 08:01:52 -06:00
2014-03-23 04:27:01 -06:00
#### Other language version
- [简体中文](README_ZH.md)
2014-03-22 18:25:39 -06:00
2014-02-12 10:49:46 -07:00
## Purpose
2014-07-26 01:02:46 -06: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 in independent binary distribution across **ALL platforms** that Go supports, including Linux, Mac OS X, and Windows.
2014-02-12 10:49:46 -07:00
2014-02-14 16:16:54 -07:00
## Overview
2014-05-01 01:27:26 -06:00
- Please see [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.
2014-03-25 13:12:23 -06:00
- See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
2014-09-15 15:23:58 -06:00
- Try it before anything? Do it [online](https://try.gogs.io/Unknown/gogs) or go down to **Installation -> Install from binary** section!
2014-05-01 01:27:26 -06:00
- Having troubles? Get help from [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).
2014-12-04 21:07:51 -07:00
- Want to help on localization? Check out [Crowdin](https://crowdin.com/project/gogs)!
2014-02-14 16:16:54 -07:00
2014-03-11 17:25:50 -06:00
## Features
2014-03-16 00:28:24 -06:00
- Activity timeline
2014-05-15 21:03:26 -06:00
- SSH/HTTP(S) protocol support
2014-06-21 15:57:59 -06:00
- SMTP/LDAP/reverse proxy authentication support
2014-10-10 19:40:51 -06:00
- Reverse proxy suburl support
2014-05-15 21:03:26 -06:00
- Register/delete/rename account
2014-08-29 01:32:52 -06:00
- Create/manage/delete organization with team management
2014-11-05 21:30:04 -07:00
- Create/fork/migrate/mirror/delete/watch/rename/transfer public/private repository
2014-09-07 17:39:26 -06:00
- Repository viewer/release/issue tracker
- Repository and Organization level webhooks
- Repository Git hooks
2014-05-15 21:03:26 -06:00
- Add/remove repository collaborators
- Gravatar and cache support
- Mail service(register, issue)
- Administration panel
2014-09-02 05:11:39 -06:00
- Slack webhook integration
2014-11-17 14:29:23 -07:00
- Drone CI integration
2014-05-15 21:03:26 -06:00
- Supports MySQL, PostgreSQL and SQLite3
2014-04-13 19:00:12 -06:00
- Social account login(GitHub, Google, QQ, Weibo)
- Multi-language support([9 languages](https://crowdin.com/project/gogs))
2014-03-11 17:25:50 -06:00
2014-04-26 01:22:22 -06: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.
2014-02-14 16:16:54 -07:00
## Installation
2014-05-01 01:27:26 -06:00
Make sure you install [Prerequirements](http://gogs.io/docs/installation/) first.
2014-03-11 22:19:45 -06:00
2014-05-12 09:02:36 -06:00
There are 5 ways to install Gogs:
2014-02-14 16:16:54 -07:00
2014-10-10 04:15:27 -06:00
- [Install from binary](http://gogs.io/docs/installation/install_from_binary.md)
2014-05-01 01:27:26 -06:00
- [Install from source](http://gogs.io/docs/installation/install_from_source.md)
2014-05-12 09:02:36 -06:00
- [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)
2014-09-05 15:28:09 -06:00
- [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
2014-05-02 17:23:06 -06:00
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
2014-02-14 16:16:54 -07:00
2014-02-12 10:49:46 -07:00
## Acknowledgments
2014-09-29 16:52:28 -06:00
- Router and middleware mechanism of [Macaron](https://github.com/Unknwon/macaron).
2014-03-22 15:59:22 -06: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).
2014-04-30 01:44:28 -06:00
- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
2014-03-24 09:44:47 -06:00
- Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
2014-11-17 15:19:17 -07:00
- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
2014-02-12 10:49:46 -07:00
## Contributors
2014-11-22 08:22:53 -07: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.
- See [TRANSLATORS](conf/locale/TRANSLATORS) for full list of translators.
## License
2014-05-24 13:28:31 -06: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.