forgejo/README.md

6.9 KiB

Gitea - Git with a cup of tea

Build Status Join the chat at https://gitter.im/go-gitea/gitea Coverage Status Go Report Card GoDoc

Status

Current version: (see Releases)

Web UI Preview
Dashboard Repository Commits History
Profile Admin Dashboard Diff
Issues Releases Organization

Important Notes

  1. YOU MUST READ THE Contributors Guide BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. If you think there are vulnerabilities in the project, please talk privately to security@gitea.io. Thanks!
  3. If you're interested in using APIs, we have experimental support with documentation.

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.

Features

  • Activity timeline
  • SSH and HTTP/HTTPS protocols
  • SMTP/LDAP/Reverse proxy authentication
  • Reverse proxy with sub-path
  • Account/Organization/Repository management
  • Add/Remove repository collaborators
  • Repository/Organization webhooks (including Slack)
  • Repository Git hooks/deploy keys
  • Repository issues, pull requests and wiki
  • Migrate and mirror repository and its wiki
  • Web editor for repository files and wiki
  • Gravatar and Federated avatar with custom source
  • Mail service
  • Administration panel
  • Supports MySQL, PostgreSQL, SQLite3 and TiDB (experimental)
  • Multi-language support (20 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

Note: As Gitea is a Gogs fork, tutorials and documentation related to gogs applies to Gitea too

How to install Gitea:

Note: binary release will be available soon

Tutorials

Screencasts

Deploy to Cloud

Software and Service Support

Product Support

Acknowledgments

  • Router and middleware mechanism of Macaron.
  • System Monitor Status is inspired by GoBlog.
  • Thanks Rocker for designing Logo.
  • Thanks Crowdin for providing open source translation plan.
  • Thanks DigitalOcean for hosting home and demo sites.
  • Thanks KeyCDN and QiNiu for providing CDN service.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

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