forgejo/README.md

5.3 KiB

Gogs - Go Git Service Build Status

Gitter

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

Demo

Current version: 0.6.5 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.
  • The demo site try.gogs.io is running under develop branch.
  • You MUST read CONTRIBUTING.md before you start filing an issue or making a Pull Request, and MUST discuss with us on Gitter for UI changes and feature Pull Requests, otherwise it's high possibilities that we are not going to merge it.
  • If you think there are vulnerabilities in the project, please talk privately 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 via an independent binary distribution across ALL platforms that Go supports, including Linux, Mac OS X, and Windows.

Overview

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

Features

  • Activity timeline
  • SSH/HTTP(S) protocol support
  • SMTP/LDAP/reverse proxy authentication support
  • Reverse proxy suburl support
  • Account/Organization(with team)/Repository management
  • Repository/Organization webhooks(including Slack)
  • Repository Git hooks/deploy keys
  • Add/remove repository collaborators
  • Gravatar and custom source support
  • Mail service
  • Administration panel
  • Drone CI integration
  • Supports MySQL, PostgreSQL and SQLite3
  • Social account login (GitHub, Google, QQ, Weibo)
  • Multi-language support (14 languages)

System Requirements

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

Browser Support

According to Semantic UI:

  • Last 2 Versions FF, Chrome, IE 10+, Safari Mac
  • IE 10+
  • Android 4

Some components will work in IE 9, but the browser is not officially supported.

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:

Tutorials

Screencasts

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 Crowdin for providing open source translation plan.

Contributors

License

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