mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-11 18:14:15 +01:00
111 lines
5.3 KiB
Markdown
111 lines
5.3 KiB
Markdown
Gogs - Go Git Service [](https://travis-ci.org/gogits/gogs)
|
|
=====================
|
|
|
|
[](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.
|
|
|
|
|
|
|
|
##### Current version: 0.6.4 Beta
|
|
|
|
### NOTICES
|
|
|
|
- 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.
|
|
- The demo site [try.gogs.io](https://try.gogs.io) is running under `develop` branch.
|
|
- 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.
|
|
- If you think there are vulnerabilities in the project, please talk privately to **u@gogs.io**. Thanks!
|
|
|
|
#### Other language version
|
|
|
|
- [简体中文](README_ZH.md)
|
|
|
|
## 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.
|
|
|
|
## 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).
|
|
- Want to help with localization? Check out the [guide](http://gogs.io/docs/features/i18n.html)!
|
|
|
|
## Features
|
|
|
|
- Activity timeline
|
|
- SSH/HTTP(S) protocol support
|
|
- SMTP/LDAP/reverse proxy authentication support
|
|
- Reverse proxy suburl support
|
|
- Account/Organization(with team)/Repository management
|
|
- Repository/Organization webhooks(including Slack)
|
|
- Repository Git hooks/deploy keys
|
|
- Add/remove repository collaborators
|
|
- Gravatar and custom source support
|
|
- Mail service
|
|
- Administration panel
|
|
- Drone CI integration
|
|
- Supports MySQL, PostgreSQL and SQLite3
|
|
- Social account login (GitHub, Google, QQ, Weibo)
|
|
- Multi-language support ([14 languages](https://crowdin.com/project/gogs))
|
|
|
|
## 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.
|
|
|
|
## Browser Support
|
|
|
|
According to [Semantic UI](https://github.com/Semantic-Org/Semantic-UI):
|
|
|
|
- Last 2 Versions FF, Chrome, IE 10+, Safari Mac
|
|
- IE 10+
|
|
- Android 4
|
|
|
|
Some components will work in IE 9, but the browser is not officially supported.
|
|
|
|
The official support minimal size is **1024*768**, UI may still looks right in smaller size but no promises and fixes.
|
|
|
|
## Installation
|
|
|
|
Make sure you install the [prerequisites](http://gogs.io/docs/installation/) first.
|
|
|
|
There are 5 ways to install Gogs:
|
|
|
|
- [Install from binary](http://gogs.io/docs/installation/install_from_binary.md)
|
|
- [Install from source](http://gogs.io/docs/installation/install_from_source.md)
|
|
- [Install from packages](http://gogs.io/docs/installation/install_from_packages.md)
|
|
- [Ship with Docker](https://github.com/gogits/gogs/tree/master/docker)
|
|
- [Install with Vagrant](https://github.com/geerlingguy/ansible-vagrant-examples/tree/master/gogs)
|
|
|
|
### 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)
|
|
- [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/)
|
|
|
|
### Screencasts
|
|
|
|
- [Instalando Gogs no Ubuntu](https://www.youtube.com/watch?v=DFNifgEHOzk) (Português)
|
|
|
|
## Acknowledgments
|
|
|
|
- Router and middleware mechanism of [Macaron](https://github.com/Unknwon/macaron).
|
|
- 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).
|
|
- Thanks [lavachen](http://www.lavachen.cn/) and [Rocker](http://weibo.com/rocker1989) for designing Logo.
|
|
- Thanks [Crowdin](https://crowdin.com/project/gogs) for providing open source translation plan.
|
|
|
|
## 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).
|
|
- 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
|
|
|
|
This project is under the MIT License. See the [LICENSE](https://github.com/gogits/gogs/blob/master/LICENSE) file for the full license text.
|