jvanderneutstulen/gogs repository overview

⁠Gogs - Go Git Service

⁠Current tip version: 0.9.97 (see Releases⁠ for binary versions)

⁠Important Notes

1. YOU MUST READ Contributing Code⁠ BEFORE STARTING TO WORK ON A PULL REQUEST.
2. Due to testing purpose, data of 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⁠ is running under develop branch.
4. If you think there are vulnerabilities in the project, please talk privately to [email protected]⁠. Thanks!
5. If you're interested in using APIs, we have experimental support with documentation⁠.
6. If your team/company is using Gogs and would like to put your logo on our website⁠, contact us by any means.

简体中文⁠

⁠Purpose

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.

⁠Overview

• Please see the Documentation⁠ for common usages and change log.
• See the Trello Board⁠ to follow the develop team.
• Want to try it before doing anything else? Do it online⁠!
• Having trouble? Get help with Troubleshooting⁠ or User Forum⁠.
• Want to help with localization? Check out the guide⁠!

⁠Features

• Activity timeline
• SSH and HTTP/HTTPS protocols
• SMTP/LDAP/Reverse proxy authentication
• Reverse proxy with sub-path
• Account/Organization/Repository management
• Add/Remove repository collaborators
• Repository/Organization webhooks (including Slack)
• Repository Git hooks/deploy keys
• Repository issues, pull requests and wiki
• Migrate and mirror repository and its wiki
• Web editor for repository files and wiki
• Gravatar and Federated avatar with custom source
• Mail service
• Administration panel
• Supports MySQL, PostgreSQL, SQLite3 and TiDB⁠ (experimental)
• Multi-language support (18 languages⁠)

⁠System Requirements

• A cheap Raspberry Pi is powerful enough for basic functionality.
• 2 CPU cores and 1GB RAM would be the baseline for teamwork.

⁠Browser Support

• Please see Semantic UI⁠ 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.

⁠Installation

Make sure you install the prerequisites⁠ first.

There are 5 ways to install Gogs:

• Install from binary⁠
• Install from source⁠
• Install from packages⁠
• Ship with Docker⁠
• Install with Vagrant⁠

⁠Tutorials

• How To Set Up Gogs on Ubuntu 14.04⁠
• Run your own GitHub-like service with the help of Docker⁠
• Dockerized Gogs git server and alpine postgres in 20 minutes or less⁠
• Host Your Own Private GitHub with Gogs.io⁠
• 使用 Gogs 搭建自己的 Git 服务器⁠ (Chinese)
• 阿里云上 Ubuntu 14.04 64 位安装 Gogs⁠ (Chinese)
• Installing Gogs on FreeBSD⁠
• Gogs on Raspberry Pi⁠
• Cloudflare Full SSL with GOGS (Go Git Service) using NGINX⁠

⁠Screencasts

• How to install Gogs on a Linux Server (DigitalOcean)⁠
• Instalando Gogs no Ubuntu⁠ (Português)

⁠Deploy to Cloud

• OpenShift⁠
• Cloudron⁠
• Scaleway⁠
• Portal⁠
• Sandstorm⁠
• sloppy.io⁠
• YunoHost⁠
• DPlatform⁠

⁠Software and Service Support

• Drone⁠ (CI)
• Fabric8⁠ (DevOps)
• Taiga⁠ (Project Management)
• Puppet⁠ (IT)
• Kanboard⁠ (Project Management)
• BearyChat⁠ (Team Communication)
• HiWork⁠ (Team Communication)

⁠Product Support

• Synology⁠ (Docker)
• One Space⁠ (App Store)

⁠Acknowledgments

• Router and middleware mechanism of Macaron⁠.
• System Monitor Status is inspired by GoBlog⁠.
• Thanks Rocker⁠ for designing Logo.
• Thanks Crowdin⁠ for providing open source translation plan.
• Thanks DigitalOcean⁠ for hosting home and demo sites.
• Thanks KeyCDN⁠ and QiNiu⁠ for providing CDN service.

⁠Contributors

• Ex-team members @lunny⁠, @fuxiaohei⁠ and @slene⁠.
• See contributors page⁠ for full list of contributors.
• See TRANSLATORS⁠ for public list of translators.

⁠License

This project is under the MIT License. See the LICENSE⁠ file for the full license text.