gitea README

The project's README from github.com/go-gitea/gitea. As one markdown file: README.md.

Gitea

繁體中文 | 简体中文

Purpose

The goal of Gitea is to make the easiest, fastest, and most painless way of setting up a self-hosted all-in-one software development service, including Git hosting, code management, code review, issue tracking, project kanban, wiki, team collaboration, package registry and CI/CD which can reuse GitHub Actions.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, FreeBSD/OpenBSD and Windows on x86, amd64, ARM, RISC-V 64 and PowerPC architectures.

For online demonstrations, you can visit demo.gitea.com.

For accessing free Gitea service (with a limited number of repositories), you can visit gitea.com.

To quickly deploy your own dedicated Gitea instance on Gitea Cloud, you can start a free trial at cloud.gitea.com, or use container (docker/podman/etc) to deploy on your own server with the official image.

Documentation

You can find comprehensive documentation on our official documentation website.

It includes installation, administration, usage, development, contributing guides, and more to help you get started and explore all features effectively.

If you have any suggestions or would like to contribute to it, you can visit the documentation repository

Building

See docs/build-setup.md for prerequisites and docs/development.md for setting up a local development environment, linting, and testing.

If you'd like to build from source or make a distribution package, see docs/build-source.md for more information.

After building, you can run ./gitea web to start the server, or ./gitea help to see all available commands.

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

[!NOTE]

  1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. New to the codebase? The development guide walks through setting up a local environment and building from source.
  3. If you have found a vulnerability in the project, please write privately to [email protected]. Thanks!

Translating

Crowdin

Translations are done through Crowdin. If you want to translate to a new language, ask one of the managers in the Crowdin project to add a new language there.

You can also just create an issue for adding a language or ask on Discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord.

Get more information from the translation section of our contributing guide.

Official and Third-Party Projects

We provide an official go-sdk, a CLI tool called tea and an action runner for Gitea Action.

We maintain a list of Gitea-related projects at gitea/awesome-gitea, where you can discover more third-party projects, including SDKs, plugins, themes, and more.

Communication

If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server or create a post in the discourse forum.

Authors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

FAQ

How do you pronounce Gitea?

Gitea is pronounced /ɡɪ’ti:/ as in "gi-tea" with a hard g.

How do I configure Gitea?

For dynamic config options, you can change it on your admin panel's configuration section.

For static config options, you can edit your app.ini file and restart the instance. See app.example.ini or configuration documentation for more details.

Where can I find the security patches?

In the release log or the change log, search for the keyword SECURITY to find the security patches.

(more FAQs are listed in FAQ documentation)

License

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

Further information

Looking for an overview of the interface? Check it out the screenshots!

Login/Register Page

Login Register

User Dashboard

Home Issues Pull Requests Milestones

User Profile

Profile

Explore

Repos Users Orgs

Repository

Home Commits Branches Labels Milestones Releases Tags

Repository Issue

List Issue

Repository Pull Requests

List Pull Request File Commits

Repository Actions

List Details

Repository Activity

Activity Contributors Code Frequency Recent Commits

Organization

Home

gitea (go-gitea/gitea)

Searching Database…

58.5K ·GitHub
Gitea
What is this?Gitea is a self-hosted, all-in-one software development service: Git hosting, code review, issue tracking, project kanban, wiki, team collaboration, a package registry and CI/CD in one package.
Is this something I install on my own server, or a hosted product?Primarily it is server software you deploy yourself (binary, Docker/Podman image, or build from source), but there's also a hosted option: a limited free service at gitea.com and a paid Gitea Cloud trial for a dedicated instance.
How do I get an instance running?Build from source and run the binary, or pull the official Docker/Podman image and deploy it on your own server. After building, start it with './gitea web'.
Is the free hosted gitea.com service unlimited?No, the free hosted instance at gitea.com caps the number of repositories you can have; for an unrestricted dedicated instance you'd self-host or use Gitea Cloud.
Which operating systems and CPU architectures does it support?Because it's written in Go, it runs on Linux, macOS, FreeBSD/OpenBSD and Windows, across x86, amd64, ARM, RISC-V 64 and PowerPC architectures.
Can I try Gitea before installing anything?Yes, there's a live demo at demo.gitea.com and a free hosted instance at gitea.com with a limited number of repositories.
Does it support GitHub Actions-style CI/CD?Yes, Gitea's built-in CI/CD (Gitea Actions) can reuse existing GitHub Actions workflows, plus there's an official action runner for it.
Are there official client tools besides the web UI?Yes, Gitea ships an official Go SDK, a CLI tool called 'tea', and an action runner for Gitea Actions, with more third-party SDKs/plugins/themes listed in the gitea/awesome-gitea repo.
How is this different from just using GitHub or GitLab?Gitea bundles Git hosting, issues, wiki, kanban boards, package registry and CI/CD into one lightweight self-hosted Go binary, so you control your own data instead of relying on a third-party SaaS.
What are similar projects?gitlabhq, renovate, gitleaks, atlas.nvim, harness, jenkins, ai-software-factory, starter-workflows
Which topics is it in?kanban-board, issue-tracker, gitlab, cicd, wiki, freebsd, version-control, ci-cd, code-review, package-manager, collaboration, github-actions
Creator
go-gitea
Size
355.8 MB
Stars
58.5K
Updated
CommitOct 16Releasev28.1.0Oct 06
Age
9y
Commits · 90 Days