Git with a cup of tea! Painless self-hosted all-in-one software development service, includes Git hosting, code review, team collaboration, package registry and CI/CD
Go to file
yp05327 5c150ce9b0
Update README.md (#33149)
~~Waiting for the upload of screenshots~~
I have a good idea about the screenshots. I will do it later.

---------

Co-authored-by: Gary Wang <git@blumia.net>
2025-01-10 16:03:07 +08:00
.devcontainer bump to go 1.23 (#31855) 2024-09-10 02:23:07 +00:00
.gitea Update demo site location from try.gitea.io -> demo.gitea.com (#31054) 2024-05-27 15:05:12 +00:00
.github Update README.md (#33149) 2025-01-10 16:03:07 +08:00
assets Convert github.com/xanzy/go-gitlab into gitlab.com/gitlab-org/api/client-go (#33126) 2025-01-08 13:10:43 +08:00
build refactor: remove redundant err declarations (#32381) 2024-10-30 19:36:24 +00:00
cmd Fix ACME panic (#33178) 2025-01-09 23:53:50 +00:00
contrib Remove outdated code about fixture generation (#32708) 2024-12-04 07:59:28 +00:00
custom/conf Make git clone URL could use current signed-in user (#33091) 2025-01-07 13:17:44 +08:00
docker Use updated path to s6-svscan after alpine upgrade (#33185) 2025-01-10 10:16:37 +08:00
models Some small refactors (#33144) 2025-01-10 06:00:06 +00:00
modules Fix sync fork for consistency (#33147) 2025-01-10 05:29:55 +00:00
options [skip ci] Updated translations via Crowdin 2025-01-10 00:32:29 +00:00
public Update dependencies, tweak eslint (#32719) 2024-12-05 16:13:10 +00:00
routers Some small refactors (#33144) 2025-01-10 06:00:06 +00:00
services Fix sync fork for consistency (#33147) 2025-01-10 05:29:55 +00:00
snap Bump CI,Flake and Snap to Node 22 (#32487) 2024-11-13 21:39:55 +00:00
templates Fix sync fork for consistency (#33147) 2025-01-10 05:29:55 +00:00
tests Fix sync fork for consistency (#33147) 2025-01-10 05:29:55 +00:00
tools Switch to `eslint-plugin-import-x` (#32790) 2024-12-12 02:07:32 +00:00
web_src Fix editor markdown not incrementing in a numbered list (#33187) 2025-01-10 07:28:38 +00:00
.air.toml Reduce `air` verbosity (#31417) 2024-06-19 19:42:06 +00:00
.changelog.yml Adapt `.changelog.yml` to new labeling system (#27701) 2023-10-20 00:22:00 +02:00
.dockerignore Add `/public/assets/img/webpack` to ignore files again (#30451) 2024-04-13 04:28:20 +02:00
.editorconfig
.envrc Enable direnv (#31672) 2024-07-23 12:07:41 +00:00
.eslintrc.cjs Fix eslint (#33002) 2024-12-27 19:34:39 +00:00
.gitattributes Add `interface{}` to `any` replacement to `make fmt`, exclude `*.pb.go` (#30461) 2024-04-13 17:32:15 +00:00
.gitignore Add .run to gitignore (#33175) 2025-01-09 18:11:35 +00:00
.gitpod.yml Remove sqlite-viewer and using database client (#31223) 2024-06-03 10:41:29 +00:00
.golangci.yml Enable tenv and testifylint rules (#32852) 2024-12-15 10:41:29 +00:00
.ignore Add `/options/license` and `/options/gitignore` to `.ignore` (#30219) 2024-03-31 22:22:29 +02:00
.markdownlint.yaml Enable markdownlint `no-trailing-punctuation` and `no-blanks-blockquote` (#29214) 2024-02-17 13:18:05 +00:00
.npmrc
.spectral.yaml
.yamllint.yaml
BSDmakefile
CHANGELOG-archived.md Fix changelog (main) (#30582) 2024-04-19 06:08:30 +00:00
CHANGELOG.md Update changelog to add missed changelog (#32734) 2024-12-06 17:31:43 +00:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Update README.md (#33149) 2025-01-10 16:03:07 +08:00
DCO
Dockerfile Fix #32954 (#32955) 2024-12-23 02:31:53 +08:00
Dockerfile.rootless Use Alpine 3.21 for the docker images (#32924) 2024-12-22 15:44:50 +00:00
LICENSE
MAINTAINERS add myself to maintainers (#33088) 2025-01-02 18:00:26 -05:00
Makefile use `-s -w` ldflags for release artifacts (#33041) 2024-12-30 02:37:59 +00:00
README.md Update README.md (#33149) 2025-01-10 16:03:07 +08:00
README_ZH.md Update README.md (#33149) 2025-01-10 16:03:07 +08:00
SECURITY.md typo on date in security document (#31617) 2024-07-11 21:51:08 +00:00
build.go
crowdin.yml Use Crowdin action for translation sync (#30054) 2024-03-30 18:11:50 +00:00
flake.lock Bump CI,Flake and Snap to Node 22 (#32487) 2024-11-13 21:39:55 +00:00
flake.nix Fix a compilation error in the Gitpod environment (#32559) 2024-11-19 14:57:55 +08:00
go.mod Convert github.com/xanzy/go-gitlab into gitlab.com/gitlab-org/api/client-go (#33126) 2025-01-08 13:10:43 +08:00
go.sum Convert github.com/xanzy/go-gitlab into gitlab.com/gitlab-org/api/client-go (#33126) 2025-01-08 13:10:43 +08:00
main.go Add some tests to clarify the "must-change-password" behavior (#30693) 2024-04-27 12:23:37 +00:00
package-lock.json Fix eslint (#33002) 2024-12-27 19:34:39 +00:00
package.json Fix eslint (#33002) 2024-12-27 19:34:39 +00:00
playwright.config.ts Add initial typescript config and use it for eslint,vitest,playwright (#31186) 2024-06-28 16:15:51 +00:00
poetry.lock Update dependencies, tweak eslint (#32719) 2024-12-05 16:13:10 +00:00
poetry.toml
pyproject.toml Update dependencies, tweak eslint (#32719) 2024-12-05 16:13:10 +00:00
stylelint.config.js Enable `declaration-block-no-redundant-longhand-properties` (#30950) 2024-05-12 02:33:05 +00:00
tailwind.config.js Add spacing to global error message (#31826) 2024-08-14 01:58:26 +00:00
tsconfig.json Enable Typescript `strictFunctionTypes` (#32911) 2024-12-22 02:59:25 +08:00
updates.config.js Update JS dependencies (#31120) 2024-05-28 01:50:28 +00:00
vitest.config.ts Convert frontend code to typescript (#31559) 2024-07-07 15:32:30 +00:00
webpack.config.js Add webpack EnvironmentPlugin (#32661) 2024-11-28 01:50:54 +00:00

README.md

Gitea

Contribute with Gitpod

View this document in Chinese

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. This project has been forked from Gogs since November of 2016, but a lot has changed.

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.

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

From the root of the source tree, run:

TAGS="bindata" make build

or if SQLite support is required:

TAGS="bindata sqlite sqlite_unlock_notify" make build

The build target is split into two sub-targets:

  • make backend which requires Go Stable, the required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater.

Internet connectivity is required to download the go and npm modules. When building from the official source tarballs which include pre-built frontend files, the frontend target will not be triggered, making it possible to build without Node.js.

More info: https://docs.gitea.com/installation/install-from-source

Using

After building, a binary file named gitea will be generated in the root of the source tree by default. To run it, use:

./gitea web

[!NOTE] If you're interested in using our APIs, we have experimental support with documentation.

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. If you have found a vulnerability in the project, please write privately to security@gitea.io. 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. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.

Get more information from documentation.

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.

Why is this not hosted on a Gitea instance?

We're working on it.

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.

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!
Dashboard User Profile Global Issues
Branches Web Editor Activity
New Migration Migrating Pull Request View
Pull Request Dark Diff Review Dark Diff Dark