forgejo-federation/README.md

119 lines
5.6 KiB
Markdown
Raw Normal View History

Gogs - Go Git Service [![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-12-21 13:23:06 +05:30
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gogits/gogs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Gogs (Go Git Service) is a painless self-hosted Git service.
2014-03-15 19:59:18 +05:30
2015-01-28 03:00:58 +05:30
![Demo](http://gogs.qiniudn.com/gogs_demo.gif)
2014-02-12 23:19:46 +05:30
2015-08-05 17:53:08 +05:30
##### Current version: 0.6.4 Beta
2014-03-13 12:25:14 +05:30
2014-04-13 08:00:00 +05:30
### NOTICES
2015-01-28 03:00:58 +05:30
- Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) has been reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
2015-03-18 16:30:55 +05:30
- The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
2015-04-22 18:20:27 +05:30
- You **MUST** read [CONTRIBUTING.md](CONTRIBUTING.md) before you start filing an issue or making a Pull Request, and **MUST** discuss with us on [Gitter](https://gitter.im/gogits/gogs) for UI changes and feature Pull Requests, otherwise it's high possibilities that we are not going to merge it.
2015-03-19 08:50:41 +05:30
- If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!
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
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 via an 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
- Please see the [Documentation](http://gogs.io/docs/intro/) for project design, known issues, and change log.
- See the [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
- Want to try it before doing anything else? Do it [online](https://try.gogs.io/unknwon/gogs) or go down to the **Installation -> Install from binary** section!
- Having trouble? Get help with [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.md).
2015-03-18 16:30:55 +05:30
- Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!
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-10-11 07:10:51 +05:30
- Reverse proxy suburl 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-11-06 10:00:04 +05:30
- Create/fork/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
- Repository Git hooks
2014-05-16 08:33:26 +05:30
- Add/remove repository collaborators
- Gravatar and cache support
- Mail service (register, issue)
2014-05-16 08:33:26 +05:30
- Administration panel
2014-09-02 16:41:39 +05:30
- Slack webhook integration
2014-11-18 02:59:23 +05:30
- Drone CI integration
2014-05-16 08:33:26 +05:30
- Supports MySQL, PostgreSQL and SQLite3
- Social account login (GitHub, Google, QQ, Weibo)
2015-07-31 09:49:40 +05:30
- Multi-language support ([14 languages](https://crowdin.com/project/gogs))
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 for basic functionality.
- At least 2 CPU cores and 1GB RAM would be the baseline for teamwork.
2014-04-26 12:52:22 +05:30
2015-07-07 11:21:28 +05:30
## Browser Support
According to [Semantic UI](https://github.com/Semantic-Org/Semantic-UI/tree/1.x):
- Last 2 Versions FF, Chrome, IE 10+
- Safari 6
- IE 9+ (Browser prefix only)
- Android 4
- Blackberry 10
Browser prefixes are present for Internet Explorer 9, but the browser is not officially supported.
2015-07-24 02:20:05 +05:30
The official support minimal size is 1024*768, UI may still looks right in smaller size but no promises and fixes.
2014-02-15 04:46:54 +05:30
## Installation
Make sure you install the [prerequisites](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-10-10 15:45:27 +05:30
- [Install from binary](http://gogs.io/docs/installation/install_from_binary.md)
2014-05-01 12:57:26 +05:30
- [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
2015-08-07 22:42:14 +05:30
### Tutorials
- [How To Set Up Gogs on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-gogs-on-ubuntu-14-04)
2015-08-07 22:47:44 +05:30
- [Run your own GitHub-like service with the help of Docker](http://blog.hypriot.com/post/run-your-own-github-like-service-with-docker/)
- [阿里云上 Ubuntu 14.04 64 位安装 Gogs](http://my.oschina.net/luyao/blog/375654) (Chinese)
- [Installing Gogs on FreeBSD](https://www.codejam.info/2015/03/installing-gogs-on-freebsd.html)
- [Gogs on Raspberry Pi](http://blog.meinside.pe.kr/Gogs-on-Raspberry-Pi/)
2015-08-07 22:42:14 +05:30
2015-08-07 21:59:50 +05:30
### Screencasts
2015-08-07 22:47:44 +05:30
- [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=DFNifgEHOzk) (Português)
2015-08-07 21:59:50 +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-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-11-18 03:49:17 +05:30
- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
2014-02-12 23:19:46 +05:30
## Contributors
- The [core team](http://gogs.io/team) of this project.
- Ex-team members [@lunny](https://github.com/lunny) and [@fuxiaohei](https://github.com/fuxiaohei).
2014-11-22 20:52:53 +05:30
- See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
- See [TRANSLATORS](conf/locale/TRANSLATORS) for full list of translators.
## 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.