forgejo/README.md

134 lines
7.2 KiB
Markdown
Raw Normal View History

2016-02-27 16:31:24 +00:00
Gogs - Go Git Service [![Build Status](https://travis-ci.org/gogits/gogs.svg?branch=master)](https://travis-ci.org/gogits/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 16:31:01 +00:00
=====================
![](https://github.com/gogits/gogs/blob/master/public/img/gogs-large-resize.png?raw=true)
2014-03-15 14:29:18 +00:00
2016-07-16 02:22:16 +00:00
##### Current tip version: 0.9.45 (see [Releases](https://github.com/gogits/gogs/releases) for binary versions)
2014-03-13 06:55:14 +00:00
2015-12-05 18:50:43 +00:00
| 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 17:41:11 +00:00
2016-02-27 16:31:24 +00:00
### Important Notes
2014-04-13 02:30:00 +00:00
2016-03-05 18:46:32 +00:00
1. **YOU MUST READ [Contributing Code](https://github.com/gogits/gogs/wiki/Contributing-Code) BEFORE STARTING TO WORK ON A PULL REQUEST**.
2016-03-05 18:09:31 +00:00
2. 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.
3. The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
4. If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!
5. If you're interested in using APIs, we have experimental support with [documentation](https://github.com/gogits/go-gogs-client/wiki).
6. 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 14:01:52 +00:00
2015-11-08 01:20:51 +00:00
[简体中文](README_ZH.md)
2014-03-23 00:25:39 +00:00
2014-02-12 17:49:46 +00:00
## Purpose
2015-11-04 23:34:08 +00:00
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 17:49:46 +00:00
2014-02-14 23:16:54 +00:00
## Overview
2015-11-05 02:57:10 +00:00
- 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-06 20:34:17 +00:00
- Want to try it before doing anything else? Do it [online](https://try.gogs.io/gogs/gogs)!
2016-02-27 16:31:24 +00:00
- Having trouble? Get help with [Troubleshooting](http://gogs.io/docs/intro/troubleshooting.html) or [User Forum](https://discuss.gogs.io/).
2015-03-18 11:00:55 +00:00
- Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!
2014-02-14 23:16:54 +00:00
2014-03-11 23:25:50 +00:00
## Features
2014-03-16 06:28:24 +00:00
- Activity timeline
2015-10-25 07:30:16 +00:00
- 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 15:38:46 +00:00
- Repository Git hooks/deploy keys
2015-12-07 04:07:02 +00:00
- Repository issues, pull requests and wiki
2015-10-25 07:30:16 +00:00
- Add/Remove repository collaborators
- Gravatar and custom source
2015-08-10 15:38:46 +00:00
- Mail service
2014-05-16 03:03:26 +00:00
- Administration panel
2015-11-05 02:57:10 +00:00
- Supports MySQL, PostgreSQL, SQLite3 and [TiDB](https://github.com/pingcap/tidb) (experimental)
2016-05-11 16:00:47 +00:00
- Multi-language support ([18 languages](https://crowdin.com/project/gogs))
2014-03-11 23:25:50 +00:00
2014-04-26 07:22:22 +00:00
## System Requirements
- A cheap Raspberry Pi is powerful enough for basic functionality.
2015-11-08 01:20:51 +00:00
- 2 CPU cores and 1GB RAM would be the baseline for teamwork.
2014-04-26 07:22:22 +00:00
2015-07-07 05:51:28 +00:00
## 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-23 20:50:05 +00:00
2014-02-14 23:16:54 +00:00
## Installation
2015-10-25 07:10:22 +00:00
Make sure you install the [prerequisites](http://gogs.io/docs/installation) first.
2014-03-12 04:19:45 +00:00
2014-05-12 15:02:36 +00:00
There are 5 ways to install Gogs:
2014-02-14 23:16:54 +00:00
2015-10-09 19:41:08 +00:00
- [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-05 21:28:09 +00:00
- [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
2014-05-02 23:23:06 +00:00
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
2014-02-14 23:16:54 +00:00
2015-08-07 17:12:14 +00:00
### 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 17:17:44 +00:00
- [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 17:17:44 +00:00
- [阿里云上 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 17:12:14 +00:00
2015-08-07 16:29:50 +00:00
### Screencasts
- [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=4UkHAR1F7ZA) (Português)
2015-08-07 16:29:50 +00:00
2015-09-12 13:21:09 +00:00
### Deploy to Cloud
- [OpenShift](https://github.com/tkisme/gogs-openshift)
2015-09-25 23:07:21 +00:00
- [Cloudron](https://cloudron.io/appstore.html#io.gogs.cloudronapp)
- [Scaleway](https://www.scaleway.com/imagehub/gogs/)
- [Portal](https://portaldemo.xyz/cloud/)
2015-10-29 07:21:59 +00:00
- [Sandstorm](https://github.com/cem/gogs-sandstorm)
2015-12-02 00:53:19 +00:00
- [sloppy.io](https://github.com/sloppyio/quickstarters/tree/master/gogs)
2016-02-05 15:19:37 +00:00
- [YunoHost](https://github.com/mbugeia/gogs_ynh)
- [DPlatform](https://github.com/j8r/DPlatform)
2015-10-29 07:21:59 +00:00
2015-12-05 18:50:43 +00:00
## 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)
2016-01-14 06:28:07 +00:00
- [Kanboard](http://kanboard.net/plugin/gogs-webhook) (Project Management)
- [BearyChat](https://bearychat.com/) (Team Communication)
2016-03-13 21:37:44 +00:00
- [HiWork](http://www.hiwork.cc/) (Team Communication)
2015-12-05 18:50:43 +00:00
2015-10-29 07:21:59 +00:00
### Product Support
- [Synology](https://www.synology.com) (Docker)
- [One Space](http://www.onespace.cc) (App Store)
2015-09-12 13:21:09 +00:00
2014-02-12 17:49:46 +00:00
## Acknowledgments
2015-10-25 07:10:22 +00:00
- Router and middleware mechanism of [Macaron](https://github.com/go-macaron/macaron).
2014-03-22 21:59:22 +00:00
- System Monitor Status is inspired by [GoBlog](https://github.com/fuxiaohei/goblog).
2014-04-30 07:44:28 +00:00
- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
2014-11-17 22:19:17 +00:00
- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
2015-11-05 19:40:22 +00:00
- Thanks [DigitalOcean](https://www.digitalocean.com) for hosting home and demo sites.
2016-02-11 18:34:21 +00:00
- Thanks [KeyCDN](https://www.keycdn.com/) for providing CDN service.
2014-02-12 17:49:46 +00:00
## Contributors
2015-10-25 07:30:16 +00:00
- Ex-team members [@lunny](https://github.com/lunny), [@fuxiaohei](https://github.com/fuxiaohei) and [@slene](https://github.com/slene).
2014-11-22 15:22:53 +00:00
- See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors.
2015-09-04 09:54:22 +00:00
- See [TRANSLATORS](conf/locale/TRANSLATORS) for public list of translators.
## License
2014-05-24 19:28:31 +00:00
This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.