README

👉 Deploy on DigitalOcean and get $200 in free credits!
  


 🔮 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 1024768, however the UI may still look right in smaller resolutions, but no promises or fixes.

 📜 Installation

Please follow the guide in our documentation.

 🙇‍♂️ Acknowledgments

This project is proudly supported by:

  
    
  


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.

Top issues

Discussions

Latest release

Fixed

- _Security:_ Reverse proxy authentication header was honored from any remote address, allowing user impersonation when Gogs was reachable directly. The header is now only trusted from addresses listed in [auth] TRUSTED_PROXY_IPS. 8264 - GHSA-w6j9-vw59-27wv
- _Security:_ Server-side request forgery in webhook deliveries via HTTP redirects to local network addresses. 8263 - GHSA-c4v7-xg93-qf8g
- _Security:_ Denial of service when rendering issue references against a malformed external issue tracker URL format. 8312 - GHSA-4j89-2c4f-44c6
- _Security:_ Stored XSS in Jupyter notebook (.ipyn