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
wxiaoguang 50a72e7a83
Use a general approach to access custom/static/builtin assets (#24022)
The idea is to use a Layered Asset File-system (modules/assetfs/layered.go)

For example: when there are 2 layers: "custom", "builtin", when access
to asset "my/page.tmpl", the Layered Asset File-system will first try to
use "custom" assets, if not found, then use "builtin" assets.

This approach will hugely simplify a lot of code, make them testable.

Other changes:

* Simplify the AssetsHandlerFunc code
* Simplify the `gitea embedded` sub-command code

---------

Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2023-04-12 18:16:45 +08:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github Improve pull_request_template.md (#22888) 2023-02-20 19:14:02 -05:00
assets Update github.com/google/go-github to v51 (#23946) 2023-04-08 19:27:30 +08:00
build Drop "unrolled/render" package (#23965) 2023-04-08 14:21:50 +08:00
cmd Use a general approach to access custom/static/builtin assets (#24022) 2023-04-12 18:16:45 +08:00
contrib Update github.com/google/go-github to v51 (#23946) 2023-04-08 19:27:30 +08:00
custom/conf Prefer native parser for SSH public key parsing (#23798) 2023-04-11 14:34:28 +08:00
docker Wrap unless-check in docker manifests (#23079) 2023-02-22 16:33:31 -06:00
docs Update documentation to explain which projects allow Gitea to host static pages (#23993) 2023-04-11 11:36:58 -05:00
models Make Release Download URLs predictable (#23891) 2023-04-12 17:05:23 +08:00
modules Use a general approach to access custom/static/builtin assets (#24022) 2023-04-12 18:16:45 +08:00
options Localize milestone related time strings (#24051) 2023-04-12 02:29:49 -04:00
public Update JS deps (#23853) 2023-04-02 19:47:14 -04:00
routers Use a general approach to access custom/static/builtin assets (#24022) 2023-04-12 18:16:45 +08:00
services Fix accidental overwriting of LDAP team memberships (#24050) 2023-04-11 19:54:26 -04:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates Localize milestone related time strings (#24051) 2023-04-12 02:29:49 -04:00
tests Avoid recursing into sub-sub-sub-docs folders when looking for READMEs. (#23695) 2023-04-10 23:00:19 -04:00
web_src Expand selected file when clicking file tree (#24041) 2023-04-12 15:06:39 +08:00
.air.toml Add more test directory to exclude dir of air, remove watching templates from air include dir because gitea has internal mechanism (#22246) 2022-12-27 14:00:34 +08:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.dockerignore Add .dockerignore (#21753) 2022-11-10 04:04:09 +01:00
.drone.yml Introduce lint-md and compliance-docs pipeline (#24021) 2023-04-09 20:05:12 +02:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Add eslint-plugin-custom-elements (#23991) 2023-04-08 05:24:42 -04:00
.gitattributes Hook go-licenses into tidy again (#21353) 2022-10-10 20:45:02 +02:00
.gitignore Add go licenses to licenses.txt (#21034) 2022-09-04 00:20:46 +02:00
.gitpod.yml Remove docs from automatically building in Gitpod (#23978) 2023-04-07 15:55:25 -04:00
.golangci.yml Fix .golangci.yml (#22868) 2023-02-11 21:44:53 +00:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +00:00
.lgtm refactor: ignore LGTM from author of pull request. (#3283) 2018-01-02 06:13:49 -06:00
.markdownlint.yaml Add markdownlint (#20512) 2022-07-28 09:22:47 +08: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
.stylelintrc.yaml Update JS deps (#23853) 2023-04-02 19:47:14 -04:00
BSDmakefile update BSDmakefile to latest version from upstream (#24063) 2023-04-11 23:42:22 -04:00
CHANGELOG.md Add CHANGELOG for 1.19.0 (#23583) 2023-03-20 15:42:23 +08:00
CODE_OF_CONDUCT.md Add Gitea Community Code of Conduct (#23188) 2023-03-09 10:49:34 +08:00
CONTRIBUTING.md Improving CONTRIBUTING.md for backport details (#23057) 2023-02-22 11:49:52 +08:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile Hardcode path to docker images (#23955) 2023-04-07 02:41:49 -04:00
Dockerfile.rootless Hardcode path to docker images (#23955) 2023-04-07 02:41:49 -04:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
MAINTAINERS Yarden Shoham has a new email address (#23767) 2023-03-28 18:24:08 +08:00
Makefile Introduce lint-md and compliance-docs pipeline (#24021) 2023-04-09 20:05:12 +02:00
README.md link update in README files (#22582) 2023-01-23 15:57:57 -05:00
README_ZH.md link update in README files (#22582) 2023-01-23 15:57:57 -05:00
SECURITY.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
go.mod Update github.com/google/go-github to v51 (#23946) 2023-04-08 19:27:30 +08:00
go.sum Update github.com/google/go-github to v51 (#23946) 2023-04-08 19:27:30 +08:00
main.go Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
package-lock.json Use auto-updating, natively hoverable, localized time elements (#23988) 2023-04-11 01:01:20 +02:00
package.json Use auto-updating, natively hoverable, localized time elements (#23988) 2023-04-11 01:01:20 +02:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
vitest.config.js Improve action log display with control chars (#23820) 2023-04-01 20:57:05 +08:00
webpack.config.js Introduce GiteaLocaleNumber custom element to handle number localization on pages. (#23861) 2023-04-03 12:58:09 -04:00

README.md

Gitea

Gitea - Git with a cup of tea

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. You can try it out using the online demo. This project has been forked from Gogs since November of 2016, but a lot has changed.

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, required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater and Internet connectivity to download npm dependencies.

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 and Internet connectivity.

Parallelism (make -j <num>) is not supported.

More info: https://docs.gitea.io/en-us/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

NOTES:

  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.io/en-us/translation-guidelines/

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 Hugo-based documentation theme is hosted at gitea/theme.

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