This repository has been archived on 2024-01-04. You can view files and clone it, but cannot push or open issues or pull requests.
forgejo/README.md
2015-11-15 23:52:46 -05:00

6.7 KiB

Gogs - Go Git Service Build Status

Gitter

Current version: 0.7.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.
  • 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!
  • If you're interested in using APIs, we have experimental support with documentation.
  • If your team/company is using Gogs and would like to put your logo on our website, contact us by any means.

简体中文

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across ALL platforms that Go supports, including Linux, Mac OS X, Windows and ARM.

Overview

  • Please see the Documentation for common usages 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 and HTTP/HTTPS protocols
  • SMTP/LDAP/Reverse proxy authentication
  • Reverse proxy with sub-path
  • Account/Organization/Repository management
  • Repository/Organization webhooks (including Slack)
  • Repository Git hooks/deploy keys
  • Repository issues and pull requests
  • Add/Remove repository collaborators
  • Gravatar and custom source
  • Mail service
  • Administration panel
  • CI integration: Drone
  • Supports MySQL, PostgreSQL, SQLite3 and TiDB (experimental)
  • Multi-language support (14 languages)

System Requirements

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

Browser Support

  • Please see Semantic UI for specific versions of supported browsers.
  • 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

Deploy to Cloud

Product Support

Acknowledgments

  • Router and middleware mechanism of Macaron.
  • 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.
  • Thanks DigitalOcean for hosting home and demo sites.

Contributors

License

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