forgejo-federation/README.md

130 lines
7.2 KiB
Markdown
Raw Normal View History

2015-12-13 01:17:11 +05:30
Gogs - Go Git Service [![Build Status](https://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/gogs) [![Docker Repository on Quay](https://quay.io/repository/gogs/gogs/status "Docker Repository on Quay")](https://quay.io/repository/gogs/gogs) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/gogs/localized.svg)](https://crowdin.com/project/gogs) [![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)
2014-03-26 22:01:01 +05:30
=====================
![](https://github.com/gogits/gogs/blob/master/public/img/gogs-large-resize.png?raw=true)
2014-03-15 19:59:18 +05:30
2016-01-11 12:04:32 +05:30
##### Current version: 0.8.19
2014-03-13 12:25:14 +05:30
2015-12-06 00:20:43 +05:30
| Web | UI | Preview |
|:-------------:|:-------:|:-------:|
|![Dashboard](https://gogs.io/img/screenshots/1.png)|![Repository](https://gogs.io/img/screenshots/2.png)|![Commits History](https://gogs.io/img/screenshots/3.png)|
|![Profile](https://gogs.io/img/screenshots/4.png)|![Admin Dashboard](https://gogs.io/img/screenshots/5.png)|![Diff](https://gogs.io/img/screenshots/6.png)|
|![Issues](https://gogs.io/img/screenshots/7.png)|![Releases](https://gogs.io/img/screenshots/8.png)|![Organization](https://gogs.io/img/screenshots/9.png)|
2015-08-15 23:11:11 +05:30
2014-04-13 08:00:00 +05:30
### NOTICES
2015-12-13 01:17:11 +05:30
- :bangbang: You **MUST** read [CONTRIBUTING.md](CONTRIBUTING.md) for bug report and contributing code. :bangbang:
2015-11-20 22:07:17 +05:30
- Please [start discussion](http://forum.gogs.io/category/2/general-discussion) or [ask a question](http://forum.gogs.io/category/4/getting-help) on [the forum](http://forum.gogs.io/). GitHub issue tracker only keeps **bugs** and **feature requests**, all other topics will be closed without reason.
2015-12-13 01:17:11 +05:30
- Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) was reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site.
- The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
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!
2015-11-08 06:50:51 +05:30
- If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogits/go-gogs-client/wiki).
- If your team/company is using Gogs and would like to put your logo on [our website](http://gogs.io), contact us by any means.
2014-03-29 19:31:52 +05:30
2015-11-08 06:50:51 +05:30
[简体中文](README_ZH.md)
2014-03-23 05:55:39 +05:30
2014-02-12 23:19:46 +05:30
## Purpose
2015-11-05 05:04:08 +05:30
The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across **ALL platforms** that Go supports, including Linux, Mac OS X, Windows and ARM.
2014-02-12 23:19:46 +05:30
2014-02-15 04:46:54 +05:30
## Overview
2015-11-05 08:27:10 +05:30
- Please see the [Documentation](http://gogs.io/docs/intro) for common usages and change log.
- See the [Trello Board](https://trello.com/b/uxAoeLUl/gogs-go-git-service) to follow the develop team.
2015-12-07 02:04:17 +05:30
- Want to try it before doing anything else? Do it [online](https://try.gogs.io/gogs/gogs)!
2015-10-10 01:11:08 +05:30
- Having trouble? Get help with [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.html).
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
2015-10-25 13:00:16 +05:30
- SSH and HTTP/HTTPS protocols
- SMTP/LDAP/Reverse proxy authentication
- Reverse proxy with sub-path
- Account/Organization/Repository management
- Repository/Organization webhooks (including Slack)
2015-08-10 21:08:46 +05:30
- Repository Git hooks/deploy keys
2015-12-07 09:37:02 +05:30
- Repository issues, pull requests and wiki
2015-10-25 13:00:16 +05:30
- Add/Remove repository collaborators
- Gravatar and custom source
2015-08-10 21:08:46 +05:30
- Mail service
2014-05-16 08:33:26 +05:30
- Administration panel
2015-11-05 08:27:10 +05:30
- Supports MySQL, PostgreSQL, SQLite3 and [TiDB](https://github.com/pingcap/tidb) (experimental)
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.
2015-11-08 06:50:51 +05:30
- 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
- Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers.
- The official support minimal size is **1024*768**, UI may still looks right in smaller size but no promises and fixes.
2015-07-24 02:20:05 +05:30
2014-02-15 04:46:54 +05:30
## Installation
2015-10-25 12:40:22 +05:30
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
2015-10-10 01:11:08 +05:30
- [Install from binary](http://gogs.io/docs/installation/install_from_binary.html)
- [Install from source](http://gogs.io/docs/installation/install_from_source.html)
- [Install from packages](http://gogs.io/docs/installation/install_from_packages.html)
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/)
- [使用 Gogs 搭建自己的 Git 服务器](https://mynook.info/blog/post/host-your-own-git-server-using-gogs) (Chinese)
2015-08-07 22:47:44 +05:30
- [阿里云上 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/)
- [Cloudflare Full SSL with GOGS (Go Git Service) using NGINX](http://www.listekconsulting.com/articles/cloudflare-full-ssl-with-gogs-go-git-service-using-nginx/)
2015-08-07 22:42:14 +05:30
2015-08-07 21:59:50 +05:30
### Screencasts
- [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=4UkHAR1F7ZA) (Português)
2015-08-07 21:59:50 +05:30
2015-09-12 18:51:09 +05:30
### Deploy to Cloud
- [OpenShift](https://github.com/tkisme/gogs-openshift)
2015-09-26 04:37:21 +05:30
- [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
- [Scaleway](https://www.scaleway.com/imagehub/gogs/)
- [Portal](https://portaldemo.xyz/cloud/)
2015-10-29 12:51:59 +05:30
- [Sandstorm](https://github.com/cem/gogs-sandstorm)
2015-12-02 06:23:19 +05:30
- [sloppy.io](https://github.com/sloppyio/quickstarters/tree/master/gogs)
2015-10-29 12:51:59 +05:30
2015-12-06 00:20:43 +05:30
## Software and Service Support
- [Drone](https://github.com/drone/drone) (CI)
- [Fabric8](http://fabric8.io/) (DevOps)
- [Taiga](https://taiga.io/) (Project Management)
- [Puppet](https://forge.puppetlabs.com/Siteminds/gogs) (IT)
2015-12-06 00:20:43 +05:30
2015-10-29 12:51:59 +05:30
### Product Support
- [Synology](https://www.synology.com) (Docker)
- [One Space](http://www.onespace.cc) (App Store)
2015-09-12 18:51:09 +05:30
2014-02-12 23:19:46 +05:30
## Acknowledgments
2015-10-25 12:40:22 +05:30
- Router and middleware mechanism of [Macaron](https://github.com/go-macaron/macaron).
- Modules design is inspired by [WeTalk](https://github.com/beego/wetalk).
2014-03-23 03:29:22 +05:30
- 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-11-18 03:49:17 +05:30
- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
2015-11-06 01:10:22 +05:30
- Thanks [DigitalOcean](https://www.digitalocean.com) for hosting home and demo sites.
2014-02-12 23:19:46 +05:30
## Contributors
2015-10-25 13:00:16 +05:30
- Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
2014-11-22 20:52:53 +05:30
- See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
2015-09-04 15:24:22 +05:30
- See [TRANSLATORS](conf/locale/TRANSLATORS) for public 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.