forgejo-federation/README.md

67 lines
3.2 KiB
Markdown
Raw Normal View History

2014-03-26 22:01:01 +05:30
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 05:55:39 +05:30
Gogs(Go Git Service) is a Self Hosted Git Service in the Go Programming Language.
2014-03-15 19:59:18 +05:30
2014-03-23 05:55:39 +05:30
![Demo](http://gowalker.org/public/gogs_demo.gif)
2014-02-12 23:19:46 +05:30
##### Current version: 0.2.0 Alpha
2014-03-13 12:25:14 +05:30
2014-03-29 19:31:52 +05:30
#### Due to testing purpose, data of [try.gogits.org](http://try.gogits.org) has been reset in March 29, 2014 and will reset multiple times after. Please do NOT put your important data on the site.
2014-03-23 15:57:01 +05:30
#### Other language version
- [简体中文](README_ZH.md)
2014-03-23 05:55:39 +05:30
2014-02-12 23:19:46 +05:30
## Purpose
2014-03-23 05:55:39 +05:30
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 23:19:46 +05:30
2014-02-15 04:46:54 +05:30
## Overview
2014-03-27 16:56:03 +05:30
- Please see [Wiki](https://github.com/gogits/gogs/wiki) for project design, known issues, change log and road map.
2014-03-26 00:42:23 +05:30
- See [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
2014-03-21 01:34:56 +05:30
- 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 12:54:17 +05:30
- Having troubles? Get help from [Troubleshooting](https://github.com/gogits/gogs/wiki/Troubleshooting).
2014-02-15 04:46:54 +05:30
2014-03-12 04:55:50 +05:30
## Features
2014-03-16 11:58:24 +05:30
- Activity timeline
2014-03-27 21:07:33 +05:30
- SSH/HTTPS(Clone only) protocol support.
2014-04-05 04:01:09 +05:30
- Register/delete/rename account.
- Create/delete/watch/rename public repository.
2014-03-16 20:05:25 +05:30
- Repository viewer.
2014-04-02 06:49:19 +05:30
- Issue tracker.
2014-03-25 23:34:57 +05:30
- Gravatar and cache support.
2014-03-26 18:52:08 +05:30
- Mail service(register, issue).
2014-03-21 11:18:10 +05:30
- Administration panel.
2014-03-21 10:39:22 +05:30
- Supports MySQL, PostgreSQL and SQLite3(binary release only).
2014-03-12 04:55:50 +05:30
2014-02-15 04:46:54 +05:30
## Installation
2014-03-12 09:49:45 +05:30
Make sure you install [Prerequirements](https://github.com/gogits/gogs/wiki/Prerequirements) first.
2014-03-11 21:10:47 +05:30
There are two ways to install Gogs:
2014-02-15 04:46:54 +05:30
2014-03-19 04:44:58 +05:30
- [Install from binary](https://github.com/gogits/gogs/wiki/Install-from-binary): **STRONGLY RECOMMENDED** for just try and deployment!
2014-03-11 21:10:47 +05:30
- [Install from source](https://github.com/gogits/gogs/wiki/Install-from-source)
2014-02-15 04:46:54 +05:30
2014-02-12 23:19:46 +05:30
## Acknowledgments
2014-03-24 17:06:38 +05:30
- Logo is inspired by [martini-contrib](https://github.com/martini-contrib).
- Router and middleware mechanism of [martini](http://martini.codegangsta.io/).
2014-03-23 03:29:22 +05:30
- 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 17:06:38 +05:30
- Usage and modification from [beego](http://beego.me) modules.
2014-03-24 21:14:47 +05:30
- Thanks [gobuild.io](http://gobuild.io) for providing binary compile and download service.
2014-02-12 23:19:46 +05:30
## Contributors
2014-04-02 06:49:19 +05:30
This project was launched by [Unknown](https://github.com/Unknwon) and [lunny](https://github.com/lunny); [fuxiaohei](https://github.com/fuxiaohei), [slene](https://github.com/slene) and [skyblue](https://github.com/shxsun) joined the team soon after. See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
## License
2014-03-27 22:18:29 +05:30
Gogs is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.