forgejo/README.md

Gogs - Go Git Service

Gogs(Go Git Service) is a painless self-hosted Git Service written in Go.

Current version: 0.5.12 Beta

NOTICES

• Due to testing purpose, data of 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.
• Demo site try.gogs.io is running under dev branch.
• If you think there are vulnerabilities in the project, please talk private to u@gogs.io, thanks!

Other language version

• 简体中文

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 in independent binary distribution across ALL platforms that Go supports, including Linux, Mac OS X, and Windows.

Overview

• Please see Documentation for project design, known issues, and change log.
• See Trello Board to follow the develop team.
• Try it before anything? Do it online or go down to Installation -> Install from binary section!
• Having troubles? Get help from Troubleshooting.
• Want to help on localization? Check out Crowdin!

Features

• Activity timeline
• SSH/HTTP(S) protocol support
• SMTP/LDAP/reverse proxy authentication support
• Reverse proxy suburl support
• Register/delete/rename account
• Create/manage/delete organization with team management
• Create/fork/migrate/mirror/delete/watch/rename/transfer public/private repository
• Repository viewer/release/issue tracker
• Repository and Organization level webhooks
• Repository Git hooks
• Add/remove repository collaborators
• Gravatar and cache support
• Mail service(register, issue)
• Administration panel
• Slack webhook integration
• Drone CI integration
• Supports MySQL, PostgreSQL and SQLite3
• Social account login(GitHub, Google, QQ, Weibo)
• Multi-language support(9 languages)

System Requirements

• A cheap Raspberry Pi is powerful enough to match the minimal requirement.
• 4 CPU Cores and 1GB RAM would be the baseline for teamwork.

Installation

Make sure you install Prerequirements first.

There are 5 ways to install Gogs:

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

Acknowledgments

• Router and middleware mechanism of Macaron.
• Mail Service, modules design is inspired by WeTalk.
• System Monitor Status is inspired by GoBlog.
• Thanks lavachen and Rocker for designing Logo.
• Thanks gobuild.io for providing binary compile and download service.
• Thanks Crowdin for providing open source translation plan.

Contributors

• The core team of this project.
• See contributors page for full list of contributors.
• See TRANSLATORS for full list of translators.

License

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