forgejo-federation/README.md

82 lines
3.8 KiB
Markdown
Raw Normal View History

2014-10-07 05:05:41 +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://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/gogs)
2014-03-26 22:01:01 +05:30
=====================
2014-07-26 12:32:46 +05:30
Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.
2014-03-15 19:59:18 +05:30
2014-09-13 05:12:11 +05:30
![Demo](https://gowalker.org/public/gogs_demo.gif)
2014-02-12 23:19:46 +05:30
2014-10-07 03:20:00 +05:30
##### Current version: 0.5.5 Beta
2014-03-13 12:25:14 +05:30
2014-04-13 08:00:00 +05:30
### NOTICES
2014-09-16 02:53:58 +05:30
- Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) has been reset in **June 21, 2014** and will reset multiple times after. Please do **NOT** put your important data on the site.
- Demo site [try.gogs.io](https://try.gogs.io) is running under `dev` branch.
2014-03-29 19:31:52 +05:30
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-07-26 12:32:46 +05:30
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 23:19:46 +05:30
2014-02-15 04:46:54 +05:30
## Overview
2014-05-01 12:57:26 +05:30
- Please see [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.
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-09-16 02:53:58 +05:30
- 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 12:57:26 +05:30
- Having troubles? Get help from [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).
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-05-16 08:33:26 +05:30
- SSH/HTTP(S) protocol support
2014-06-22 03:27:59 +05:30
- SMTP/LDAP/reverse proxy authentication support
2014-05-16 08:33:26 +05:30
- Register/delete/rename account
2014-08-29 13:02:52 +05:30
- Create/manage/delete organization with team management
2014-05-16 08:33:26 +05:30
- Create/migrate/mirror/delete/watch/rename/transfer public/private repository
2014-09-08 05:09:26 +05:30
- Repository viewer/release/issue tracker
- Repository and Organization level webhooks
2014-05-16 08:33:26 +05:30
- Add/remove repository collaborators
- Gravatar and cache support
- Mail service(register, issue)
- Administration panel
2014-09-02 16:41:39 +05:30
- Slack webhook integration
2014-05-16 08:33:26 +05:30
- Supports MySQL, PostgreSQL and SQLite3
2014-04-14 06:30:12 +05:30
- Social account login(GitHub, Google, QQ, Weibo)
2014-10-07 03:20:00 +05:30
- Multi-language support(English, Chinese, Germany, French, Dutch etc.)
2014-03-12 04:55:50 +05:30
2014-04-26 12:52:22 +05:30
## 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-15 04:46:54 +05:30
## Installation
2014-05-01 12:57:26 +05:30
Make sure you install [Prerequirements](http://gogs.io/docs/installation/) first.
2014-03-12 09:49:45 +05:30
2014-05-12 20:32:36 +05:30
There are 5 ways to install Gogs:
2014-02-15 04:46:54 +05:30
2014-05-01 12:57:26 +05:30
- [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-05-12 20:32:36 +05:30
- [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)
2014-09-06 02:58:09 +05:30
- [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
2014-05-03 04:53:06 +05:30
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
2014-02-15 04:46:54 +05:30
2014-02-12 23:19:46 +05:30
## Acknowledgments
2014-09-30 04:22:28 +05:30
- Router and middleware mechanism of [Macaron](https://github.com/Unknwon/macaron).
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-04-30 13:14:28 +05:30
- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
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-05-05 13:57:28 +05:30
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.
## License
2014-05-25 00:58:31 +05:30
This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.