This repository has been archived on 2023-02-01. You can view files and clone it, but cannot push or open issues or pull requests.
gitea/README.md

80 lines
3.9 KiB
Markdown
Raw Normal View History

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