forgejo/README.md

112 lines
5.3 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 20:31:01 +04:00
=====================
2014-12-21 10:53:06 +03:00
[![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 18:29:18 +04:00
2015-01-28 00:30:58 +03:00
![Demo](http://gogs.qiniudn.com/gogs_demo.gif)
2014-02-12 21:49:46 +04:00
##### Current version: 0.6.5 Beta
2014-03-13 10:55:14 +04:00
2014-04-13 06:30:00 +04:00
### NOTICES
2015-01-28 00:30:58 +03:00
- 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 14:00:55 +03:00
- The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
2015-04-22 15:50:27 +03:00
- 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 06:20:41 +03:00
- If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!
2014-03-29 18:01:52 +04:00
2014-03-23 14:27:01 +04:00
#### Other language version
- [简体中文](README_ZH.md)
2014-03-23 04:25:39 +04:00
2014-02-12 21:49:46 +04:00
## 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 21:49:46 +04:00
2014-02-15 03:16:54 +04:00
## 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 14:00:55 +03:00
- Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!
2014-02-15 03:16:54 +04:00
2014-03-12 03:25:50 +04:00
## Features
2014-03-16 10:28:24 +04:00
- Activity timeline
2014-05-16 07:03:26 +04:00
- SSH/HTTP(S) protocol support
2014-06-22 01:57:59 +04:00
- SMTP/LDAP/reverse proxy authentication support
2014-10-11 05:40:51 +04:00
- Reverse proxy suburl support
2015-08-10 18:38:46 +03:00
- Account/Organization(with team)/Repository management
- Repository/Organization webhooks(including Slack)
- Repository Git hooks/deploy keys
2014-05-16 07:03:26 +04:00
- Add/remove repository collaborators
2015-08-10 18:38:46 +03:00
- Gravatar and custom source support
- Mail service
2014-05-16 07:03:26 +04:00
- Administration panel
2014-11-18 00:29:23 +03:00
- Drone CI integration
2014-05-16 07:03:26 +04:00
- Supports MySQL, PostgreSQL and SQLite3
- Social account login (GitHub, Google, QQ, Weibo)
2015-07-31 07:19:40 +03:00
- Multi-language support ([14 languages](https://crowdin.com/project/gogs))
2014-03-12 03:25:50 +04:00
2014-04-26 11:22:22 +04:00
## 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 11:22:22 +04:00
2015-07-07 08:51:28 +03:00
## Browser Support
2015-08-11 21:38:46 +03:00
According to [Semantic UI](https://github.com/Semantic-Org/Semantic-UI):
2015-07-07 08:51:28 +03:00
2015-08-11 21:38:46 +03:00
- Last 2 Versions FF, Chrome, IE 10+, Safari Mac
- IE 10+
2015-07-07 08:51:28 +03:00
- Android 4
2015-08-11 21:38:46 +03:00
Some components will work in IE 9, but the browser is not officially supported.
2015-07-07 08:51:28 +03:00
2015-08-11 21:38:46 +03:00
The official support minimal size is **1024*768**, UI may still looks right in smaller size but no promises and fixes.
2015-07-23 23:50:05 +03:00
2014-02-15 03:16:54 +04:00
## Installation
Make sure you install the [prerequisites](http://gogs.io/docs/installation/) first.
2014-03-12 08:19:45 +04:00
2014-05-12 19:02:36 +04:00
There are 5 ways to install Gogs:
2014-02-15 03:16:54 +04:00
2014-10-10 14:15:27 +04:00
- [Install from binary](http://gogs.io/docs/installation/install_from_binary.md)
2014-05-01 11:27:26 +04:00
- [Install from source](http://gogs.io/docs/installation/install_from_source.md)
2014-05-12 19:02:36 +04:00
- [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)
2014-09-06 01:28:09 +04:00
- [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
2014-05-03 03:23:06 +04:00
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
2014-02-15 03:16:54 +04:00
2015-08-07 20:12:14 +03: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 20:17:44 +03: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/)
- [阿里云上 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 20:12:14 +03:00
2015-08-07 19:29:50 +03:00
### Screencasts
2015-08-07 20:17:44 +03:00
- [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=DFNifgEHOzk) (Português)
2015-08-07 19:29:50 +03:00
2014-02-12 21:49:46 +04:00
## Acknowledgments
2014-09-30 02:52:28 +04:00
- Router and middleware mechanism of [Macaron](https://github.com/Unknwon/macaron).
2014-03-23 01:59:22 +04: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-04-30 11:44:28 +04:00
- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
2014-11-18 01:19:17 +03:00
- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
2014-02-12 21:49:46 +04:00
## 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 18:22:53 +03:00
- 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-24 23:28:31 +04: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.