0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-24 16:16:35 -05:00
forgejo/README.md

75 lines
3.7 KiB
Markdown
Raw Normal View History

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