gitea/README.md

80 lines
3.9 KiB
Markdown
Raw Normal View History

2014-03-26 09:31:01 -07: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)
=====================
2014-03-22 17:25:39 -07:00
Gogs(Go Git Service) is a Self Hosted Git Service in the Go Programming Language.
2014-03-15 07:29:18 -07:00
2014-03-22 17:25:39 -07:00
![Demo](http://gowalker.org/public/gogs_demo.gif)
2014-02-12 10:49:46 -07:00
2014-04-28 18:53:40 -07:00
##### Current version: 0.3.1 Alpha
2014-03-12 23:55:14 -07:00
2014-04-12 19:30:00 -07:00
### NOTICES
2014-04-13 23:50:13 -07:00
- Due to testing purpose, data of [try.gogits.org](http://try.gogits.org) has been reset in **April 14, 2014** and will reset multiple times after. Please do **NOT** put your important data on the site.
2014-04-12 19:30:00 -07:00
- Demo site [try.gogits.org](http://try.gogits.org) is running under `dev` branch.
2014-03-29 07:01:52 -07:00
2014-03-23 03:27:01 -07:00
#### Other language version
- [简体中文](README_ZH.md)
2014-03-22 17:25:39 -07:00
2014-02-12 10:49:46 -07:00
## Purpose
2014-03-22 17:25:39 -07: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!
2014-02-12 10:49:46 -07:00
2014-02-14 16:16:54 -07:00
## Overview
2014-05-01 00:27:26 -07:00
- Please see [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.
2014-03-25 12:12:23 -07:00
- See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
2014-03-20 13:04:56 -07:00
- Try it before anything? Do it [online](http://try.gogits.org/Unknown/gogs) or go down to **Installation -> Install from binary** section!
2014-05-01 00:27:26 -07:00
- Having troubles? Get help from [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).
2014-02-14 16:16:54 -07:00
2014-03-11 16:25:50 -07:00
## Features
2014-03-15 23:28:24 -07:00
- Activity timeline
2014-04-08 09:41:33 -07:00
- SSH/HTTP(S) protocol support.
2014-04-04 15:31:09 -07:00
- Register/delete/rename account.
2014-04-12 17:35:35 -07:00
- Create/migrate/mirror/delete/watch/rename/transfer public/private repository.
2014-04-13 23:50:13 -07:00
- Repository viewer/release/issue tracker.
2014-03-25 11:04:57 -07:00
- Gravatar and cache support.
2014-03-26 06:22:08 -07:00
- Mail service(register, issue).
2014-03-20 22:48:10 -07:00
- Administration panel.
2014-04-12 17:35:35 -07:00
- Supports MySQL, PostgreSQL and SQLite3.
2014-04-13 18:00:12 -07:00
- Social account login(GitHub, Google, QQ, Weibo)
2014-03-11 16:25:50 -07:00
2014-04-26 00:22:22 -07: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 00:27:26 -07:00
Make sure you install [Prerequirements](http://gogs.io/docs/installation/) first.
2014-03-11 21:19:45 -07:00
2014-04-11 10:24:19 -07:00
There are 3 ways to install Gogs:
2014-02-14 16:16:54 -07:00
2014-05-01 00:27:26 -07: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)
2014-04-11 09:26:23 -07:00
- [Ship with Docker](https://github.com/gogits/gogs/tree/master/dockerfiles)
2014-02-14 16:16:54 -07:00
2014-02-12 10:49:46 -07:00
## Acknowledgments
2014-03-24 04:36:38 -07:00
- Router and middleware mechanism of [martini](http://martini.codegangsta.io/).
2014-03-22 14:59:22 -07: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-03-24 04:36:38 -07:00
- Usage and modification from [beego](http://beego.me) modules.
2014-04-30 00:44:28 -07:00
- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
2014-03-24 08:44:47 -07:00
- Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
2014-04-11 09:26:23 -07:00
- Great thanks to [Docker China](http://www.dockboard.org/) for providing [dockerfiles](https://github.com/gogits/gogs/tree/master/dockerfiles).
2014-02-12 10:49:46 -07:00
## Contributors
2014-04-21 15:53:04 -07:00
This project was launched by [Unknwon](https://github.com/Unknwon) and [lunny](https://github.com/lunny); [fuxiaohei](https://github.com/fuxiaohei), [slene](https://github.com/slene) and [codeskyblue](https://github.com/codeskyblue) joined the team soon after. See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
2014-04-15 17:01:20 -07:00
[![Clone in Koding](http://learn.koding.com/btn/clone_d.png)][koding]
[koding]: https://koding.com/Teamwork?import=https://github.com/gogits/gogs/archive/master.zip&c=git1
## License
2014-03-27 09:48:29 -07:00
Gogs is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.