Go to file
wxiaoguang 2cdf260f42
Refactor path & config system (#25330)
# The problem

There were many "path tricks":

* By default, Gitea uses its program directory as its work path
* Gitea tries to use the "work path" to guess its "custom path" and
"custom conf (app.ini)"
* Users might want to use other directories as work path
* The non-default work path should be passed to Gitea by GITEA_WORK_DIR
or "--work-path"
* But some Gitea processes are started without these values
    * The "serv" process started by OpenSSH server
    * The CLI sub-commands started by site admin
* The paths are guessed by SetCustomPathAndConf again and again
* The default values of "work path / custom path / custom conf" can be
changed when compiling

# The solution

* Use `InitWorkPathAndCommonConfig` to handle these path tricks, and use
test code to cover its behaviors.
* When Gitea's web server runs, write the WORK_PATH to "app.ini", this
value must be the most correct one, because if this value is not right,
users would find that the web UI doesn't work and then they should be
able to fix it.
* Then all other sub-commands can use the WORK_PATH in app.ini to
initialize their paths.
* By the way, when Gitea starts for git protocol, it shouldn't output
any log, otherwise the git protocol gets broken and client blocks
forever.

The "work path" priority is: WORK_PATH in app.ini > cmd arg --work-path
> env var GITEA_WORK_DIR > builtin default

The "app.ini" searching order is: cmd arg --config > cmd arg "work path
/ custom path" > env var "work path / custom path" > builtin default


## ⚠️ BREAKING

If your instance's "work path / custom path / custom conf" doesn't meet
the requirements (eg: work path must be absolute), Gitea will report a
fatal error and exit. You need to set these values according to the
error log.



----

Close #24818
Close #24222
Close #21606
Close #21498
Close #25107
Close #24981
Maybe close #24503

Replace #23301
Replace #22754

And maybe more
2023-06-21 13:50:26 +08:00
.devcontainer Add git-lfs support to devcontainer (#25385) 2023-06-20 19:28:46 +00:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github Use Actions git context instead of dynamically created buildkit one (#25381) 2023-06-20 01:37:32 -04:00
assets Update github.com/google/go-github to v53 (#25157) 2023-06-09 19:42:51 +00:00
build Refactor INI package (first step) (#25024) 2023-06-02 17:27:30 +08:00
cmd Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
contrib Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
custom/conf Use the new download domain replace the old (#25405) 2023-06-21 03:11:17 +00:00
docker Unify nightly naming across binaries and docker images (#24116) 2023-04-24 23:43:19 +08:00
docs Use the new download domain replace the old (#25405) 2023-06-21 03:11:17 +00:00
models Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
modules Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
options Add actor and status dropdowns to run list (#25118) 2023-06-21 04:25:14 +00:00
public/img Update JS dependencies, remove space after emoji completion (#25266) 2023-06-18 08:38:47 +00:00
routers Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
services Use the new download domain replace the old (#25405) 2023-06-21 03:11:17 +00:00
snap Upgrade snap to node 20 (#24990) 2023-05-29 22:41:56 +02:00
templates Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
tests Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
web_src Add actor and status dropdowns to run list (#25118) 2023-06-21 04:25:14 +00:00
.air.toml Reduce verbosity of dev commands (#24917) 2023-05-24 20:11:04 +00:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.dockerignore Remove the service worker (#25010) 2023-05-31 02:07:04 +00:00
.drone.yml build nightly docker images (#25317) 2023-06-18 01:04:23 -04:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update js dependencies (#25137) 2023-06-08 10:54:31 +00:00
.gitattributes Remove more unused Fomantic variants (#25292) 2023-06-17 08:15:33 +00:00
.gitignore Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
.gitpod.yml Use qwtel.sqlite-viewer instead of alexcvzz.vscode-sqlite (#25386) 2023-06-20 19:06:42 +00:00
.golangci.yml Refactor INI package (first step) (#25024) 2023-06-02 17:27:30 +08:00
.ignore Remove the service worker (#25010) 2023-05-31 02:07:04 +00: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 dependencies, remove space after emoji completion (#25266) 2023-06-18 08:38:47 +00:00
BSDmakefile update BSDmakefile to latest version from upstream (#24063) 2023-04-11 23:42:22 -04:00
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
CHANGELOG.md Changelog for 1.19.3 (#24495) (#24506) 2023-05-03 22:05:47 -04:00
CODE_OF_CONDUCT.md Add Gitea Community Code of Conduct (#23188) 2023-03-09 10:49:34 +08:00
CONTRIBUTING.md Use the new download domain replace the old (#25405) 2023-06-21 03:11:17 +00:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile Update to Alpine 3.18 (#24700) 2023-05-14 01:49:00 +00:00
Dockerfile.rootless Update to Alpine 3.18 (#24700) 2023-05-14 01:49:00 +00:00
go.mod Support changing labels of Actions runner without re-registration (#24806) 2023-06-13 22:28:31 +08:00
go.sum Support changing labels of Actions runner without re-registration (#24806) 2023-06-13 22:28:31 +08:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
main.go Refactor path & config system (#25330) 2023-06-21 13:50:26 +08:00
MAINTAINERS Add self to maintainers (#23644) 2023-05-25 07:58:38 +08:00
Makefile Use Actions git context instead of dynamically created buildkit one (#25381) 2023-06-20 01:37:32 -04:00
package-lock.json Clean up pyproject.toml and package.json, fix poetry options (#25327) 2023-06-18 18:13:08 +00:00
package.json Clean up pyproject.toml and package.json, fix poetry options (#25327) 2023-06-18 18:13:08 +00:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
poetry.lock Add template linting via djlint (#25212) 2023-06-14 18:17:58 +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 Clean up pyproject.toml and package.json, fix poetry options (#25327) 2023-06-18 18:13:08 +00:00
README_ZH.md Use the new download domain replace the old (#25405) 2023-06-21 03:11:17 +00:00
README.md Use the new download domain replace the old (#25405) 2023-06-21 03:11:17 +00:00
SECURITY.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
vitest.config.js Update JS dependencies (#24218) 2023-04-19 22:36:41 -04:00
webpack.config.js Update JS dependencies, remove space after emoji completion (#25266) 2023-06-18 08:38:47 +00:00

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