gogs

command module
v0.12.6-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 19, 2022 License: MIT Imports: 5 Imported by: 1

README ยถ

Gogs - A painless self-hosted Git service

GitHub Workflow Status Discord Sourcegraph

Repository

็ฎ€ไฝ“ไธญๆ–‡

๐Ÿ”ฎ Vision

The Gogs (/gษ‘gz/) project aims to build a simple, stable and extensible self-hosted Git service that can be setup 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.

๐Ÿ“ก Overview

๐Ÿ’Œ 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, including PostgreSQL, MySQL, SQLite3 and TiDB.
  • Have localization over 30 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

Make sure you install the prerequisites first.

There are 6 ways to install Gogs:

Deploy to cloud
Tutorials

๐Ÿ“ฆ Software, service and product support

๐Ÿ™‡โ€โ™‚๏ธ Acknowledgments

๐Ÿ‘‹ Contributors

License

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

Documentation ยถ

Overview ยถ

Gogs is a painless self-hosted Git Service.

Directories ยถ

Path Synopsis
internal
app
auth/ldap
Package ldap provide functions & structure to query a LDAP ldap directory For now, it's mainly tested again an MS Active Directory service, see README.md for more information
Package ldap provide functions & structure to query a LDAP ldap directory For now, it's mainly tested again an MS Active Directory service, see README.md for more information
cmd
db
FIXME: Put this file into its own package and separate into different files based on login sources.
FIXME: Put this file into its own package and separate into different files based on login sources.
lazyregexp
Package lazyregexp is a thin wrapper over regexp, allowing the use of global regexp variables without forcing them to be compiled at init.
Package lazyregexp is a thin wrapper over regexp, allowing the use of global regexp variables without forcing them to be compiled at init.
ssh

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL