gogs

Built by gogs

A painless, minimal Git server that runs almost anywhere.

Developer tools

About

What it does

Gogs is a simple self-hosted Git service focused on doing the essentials well. You get repositories, issues, pull requests and wikis behind a clean web interface, with very little to configure.

Written in Go, it is light enough to run comfortably on modest hardware, which makes it a good fit for small teams and personal projects.

Highlights

Repositories over SSH and HTTP
Issues, pull requests and wikis
Organizations, teams and collaborator permissions
Webhooks and repository mirroring
Very low memory and CPU footprint

Who it's for

Small teams and individuals who want private Git hosting without the overhead.

Readme

from the project's repository

Show the full readme from GitHub

🔮 Vision

The Gogs (/gɑgz/) project aims to build a simple, stable and extensible self-hosted Git service that can be set up in the most painless way. With Go, this can be done with an independent binary distribution across all platforms that Go supports, including Linux, macOS, Windows and ARM-based systems.

📡 Overview

Please visit our home page for user documentation.
Please refer to CHANGELOG.md for list of changes in each releases.
Want to try it before doing anything else? Do it online!
Having trouble? Help yourself with troubleshooting or ask questions in Discussions.
Want to help with localization? Check out the localization documentation.
Ready to get hands dirty? Read our contributing guide.
Hmm... What about APIs? We have experimental support with documentation.

💌 Features

User dashboard, user profile and activity timeline.
Access repositories via SSH, HTTP and HTTPS protocols.
User, organization and repository management.
Repository and organization webhooks, including Slack, Discord and Dingtalk.
Repository Git hooks, deploy keys and Git LFS.
Repository issues, pull requests, wiki, protected branches and collaboration.
Migrate and mirror repositories with wiki from other code hosts.
Web editor for quick editing repository files and wiki.
Jupyter Notebook and PDF rendering.
Authentication via SMTP, LDAP, reverse proxy, GitHub.com and GitHub Enterprise with 2FA.
Customize HTML templates, static files and many others.
Rich database backend support, including PostgreSQL, MySQL, MariaDB, SQLite3 or any database backend that speaks one of those protocols.
Have localization over 31 languages.

💾 Hardware requirements

A Raspberry Pi or $5 Digital Ocean Droplet is more than enough to get you started. Some even use 64MB RAM Docker CaaS.
2 CPU cores and 512MB RAM would be the baseline for teamwork.
Increase CPU cores when your team size gets significantly larger, memory footprint remains low.

💻 Browser support

Please see Semantic UI for specific versions of supported browsers.
The smallest resolution officially supported is 1024*768, however the UI may still look right in smaller resolutions, but no promises or fixes.

📜 Installation

Please follow the guide in our documentation.

Deploy to cloud

Tutorials

📦 Software, service and product support

Jenkins (CI)
Puppet (IT)
Synology (Docker)
Syncloud (App Store)

🙇‍♂️ Acknowledgments

Other acknowledgments:

Thanks Egon Elbre for designing the original version of the logo.
Thanks Mintlify for sponsoring open source documentation plan.
Thanks Crowdin for sponsoring open source translation plan.
Thanks Buildkite for sponsoring open source CI/CD plan.

👋 Contributors

See contributors page for top 100 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.