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
KN4CK3R 4e7b067a7f
Extract and display readme and comments for Composer packages (#30927)
Related #30075

CC @thojo0

Example with rendered readme:

![grafik](https://github.com/go-gitea/gitea/assets/1666336/3516fef5-2631-40fd-8841-5d9894ec8904)
2024-06-14 04:45:52 +00:00
.devcontainer Remove sqlite-viewer and using database client (#31223) 2024-06-03 10:41:29 +00:00
.gitea Update demo site location from try.gitea.io -> demo.gitea.com (#31054) 2024-05-27 15:05:12 +00:00
.github Have new announcement about docs contributions (#31364) 2024-06-14 11:17:05 +08:00
assets Azure blob storage support (#30995) 2024-05-30 07:33:50 +00:00
build Add `interface{}` to `any` replacement to `make fmt`, exclude `*.pb.go` (#30461) 2024-04-13 17:32:15 +00:00
cmd fix: allow actions artifacts storage migration to complete succesfully (#31251) 2024-06-05 12:00:56 +08:00
contrib Bump `github.com/google/go-github` to v61 (#30738) 2024-04-28 01:20:23 -04:00
custom/conf Add `MAX_ROWS` option for CSV rendering (#30268) 2024-06-06 16:06:59 +08:00
docker Update README.md (#30856) 2024-05-03 23:53:18 -04:00
docs Allow including `Reviewed-on`/`Reviewed-by` lines for custom merge messages (#31211) 2024-06-06 08:35:04 +00:00
models Fix PullRequestList.GetIssueIDs's logic (#31352) 2024-06-13 09:42:07 +00:00
modules Extract and display readme and comments for Composer packages (#30927) 2024-06-14 04:45:52 +00:00
options [skip ci] Updated translations via Crowdin 2024-06-14 00:27:38 +00:00
public Update various logos and unify their filenames (#29637) 2024-03-06 22:20:05 +00:00
routers [Refactor] Unify repo search order by logic (#30876) 2024-06-13 09:13:11 +00:00
services Fix #31185 try fix lfs download from bitbucket failed (#31201) 2024-06-11 22:22:28 +00:00
snap bump to use go 1.22 (#29119) 2024-02-14 18:19:57 +00:00
templates Extract and display readme and comments for Composer packages (#30927) 2024-06-14 04:45:52 +00:00
tests Fix #31185 try fix lfs download from bitbucket failed (#31201) 2024-06-11 22:22:28 +00:00
tools Add `lint-go-gopls` (#30729) 2024-06-05 09:22:38 +08:00
web_src Improve detecting empty files (#31332) 2024-06-13 01:06:46 +00:00
.air.toml Kill all gitea processes before air build (#30477) 2024-04-15 08:24:36 +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 Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Use `querySelector` over alternative DOM methods (#31280) 2024-06-10 22:49:33 +02:00
.gitattributes Add `interface{}` to `any` replacement to `make fmt`, exclude `*.pb.go` (#30461) 2024-04-13 17:32:15 +00:00
.gitignore Add `/public/assets/img/webpack` to ignore files again (#30451) 2024-04-13 04:28:20 +02:00
.gitpod.yml Remove sqlite-viewer and using database client (#31223) 2024-06-03 10:41:29 +00:00
.golangci.yml Enable `unparam` linter (#31277) 2024-06-11 18:47:45 +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 Upgrade to npm lockfile v3 and explicitely set it (#23561) 2023-03-18 19:38:10 +01:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.yamllint.yaml fully replace drone with actions (#27556) 2023-10-11 06:39:32 +00:00
BSDmakefile Fix build errors on BSD (in BSDMakefile) (#27594) 2023-10-13 15:38:27 +00:00
CHANGELOG-archived.md Fix changelog (main) (#30582) 2024-04-19 06:08:30 +00:00
CHANGELOG.md Fix changelog (main) (#30582) 2024-04-19 06:08:30 +00:00
CODE_OF_CONDUCT.md Add Gitea Community Code of Conduct (#23188) 2023-03-09 10:49:34 +08:00
CONTRIBUTING.md Have new announcement about docs contributions (#31364) 2024-06-14 11:17:05 +08:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile Alpine 3.20 has been released (#31047) 2024-05-23 12:18:25 +00:00
Dockerfile.rootless Alpine 3.20 has been released (#31047) 2024-05-23 12:18:25 +00:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
MAINTAINERS Apply to become a maintainer (#30884) 2024-05-07 14:41:52 +02:00
Makefile Enable poetry non-package mode (#31282) 2024-06-07 15:37:33 +02:00
README.md Update demo site location from try.gitea.io -> demo.gitea.com (#31054) 2024-05-27 15:05:12 +00:00
README_ZH.md Update demo site location from try.gitea.io -> demo.gitea.com (#31054) 2024-05-27 15:05:12 +00:00
SECURITY.md fix wording in SECURITY.md (#27463) 2023-10-06 05:17:29 +08:00
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
crowdin.yml Use Crowdin action for translation sync (#30054) 2024-03-30 18:11:50 +00:00
flake.lock update nix flake and add gofumpt (#31320) 2024-06-11 08:47:13 -05:00
flake.nix update nix flake and add gofumpt (#31320) 2024-06-11 08:47:13 -05:00
go.mod Update `golang.org/x/net` (#31260) 2024-06-06 04:29:42 +00:00
go.sum Update `golang.org/x/net` (#31260) 2024-06-06 04:29:42 +00: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 dates displaying in a wrong manner when we're close to the end of the month (#31331) 2024-06-12 10:27:00 +00:00
package.json Fix dates displaying in a wrong manner when we're close to the end of the month (#31331) 2024-06-12 10:27:00 +00:00
playwright.config.js Enforce trailing comma in JS on multiline (#30002) 2024-03-22 14:06:53 +00:00
poetry.lock Upgrade `tqdm` dependency (#30996) 2024-05-16 19:40:57 +00:00
poetry.toml Clean up pyproject.toml and package.json, fix poetry options (#25327) 2023-06-18 18:13:08 +00:00
pyproject.toml Enable poetry non-package mode (#31282) 2024-06-07 15:37:33 +02:00
stylelint.config.js Enable `declaration-block-no-redundant-longhand-properties` (#30950) 2024-05-12 02:33:05 +00:00
tailwind.config.js Move custom `tw-` helpers to tailwind plugin (#31184) 2024-06-03 18:21:28 +00:00
updates.config.js Update JS dependencies (#31120) 2024-05-28 01:50:28 +00:00
vitest.config.js Switch to happy-dom for testing (#29948) 2024-03-21 14:05:24 +00:00
webpack.config.js replace jquery-minicolors with coloris (#30055) 2024-03-29 04:00:07 +01: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.

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

./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

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.

https://docs.gitea.com/contributing/localization

Crowdin

Further information

For more information and instructions about how to install Gitea, please look at our documentation. 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.

We maintain a list of Gitea-related projects at gitea/awesome-gitea.

The official Gitea CLI is developed at gitea/tea.

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.

License

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

Screenshots

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