Go to file
mpeter50 371dd96e3e
Clarify logging documentation (#21665)
My pull request changes the logging documentation that is visible here:
https://docs.gitea.io/en-us/logging-configuration/
The reason behind the changes is that for some time I've found the
logging documentation confusing, and wanted to give a try at making it
more clear.

---

If you find the existing changes to be ok, please don't merge yet, as I
have further ideas which I want to discuss with you before making the
changes.

### Swap the "Log Groups" and "Log outputs" sections.
I want to move the "Log outputs" section before the "Log Groups"
section. The reason is that the "Log Groups" section refers to ini
sections that are only later explained, and to concepts that are general
and should be documented in "Log outputs" or a different section.

This change is essentially a swap of the "Log Groups" and "Log outputs"
sections. That way the doumentation would follow the structure in which
the ini file is built: first explaining the outer sections, and then the
inner ones ([log], [log.name], [log.name.default], ...)

### Explain the workings of ambigous settings below the settings listing
Right now the basics of a setting is shown later than the explanation of
its special workings, for example with `FILE_NAME` at [the file output
mode](https://docs.gitea.io/en-us/logging-configuration/#file-mode)
(well, if the first changes are taken into account).

Currently I have `TODO` witten at 2 settings, which I have to figure out
how do they exactly work before I can document them.

### New section about [log]
New section after "Collecting Logs for Help" about how the top level
[log] itself works and what can go there.
Currently, variables that directly go into [log] are noted throughout
the whole document.

---

Please let me know what you think about the changes.

A counterargument that I myself see is that some of this is already
present in the cheatsheet, but I think it would be better to have [this
document](https://docs.gitea.io/en-us/logging-configuration/) as a
throrough explanation of how logging is configured, and the cheatsheet
would only have a short outline of the possible sections and variables.

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-11-22 09:04:29 +08:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github update discord invite (#19907) 2022-06-07 11:40:27 -04:00
assets Split migrations folder (#21549) 2022-11-02 16:54:36 +08:00
build Simplify fmt-check (#21458) 2022-10-16 16:11:17 +08:00
cmd Add `context.Context` to more methods (#21546) 2022-11-19 16:12:33 +08:00
contrib Add link to user profile in markdown mention only if user exists (#21533) 2022-10-23 01:15:52 +08:00
custom/conf Allow disable RSS/Atom feed (#21622) 2022-11-21 13:14:58 +08:00
docker Remove deprecated DSA host key from Docker Container (#21522) 2022-11-03 19:49:12 +08:00
docs Clarify logging documentation (#21665) 2022-11-22 09:04:29 +08:00
models Add package registry cleanup rules (#21658) 2022-11-20 16:08:38 +02:00
modules Replace yaml.v2 with yaml.v3 (#21832) 2022-11-21 16:36:59 +08:00
options Improvements for Content Copy (#21842) 2022-11-21 17:59:42 +08:00
public Update JS dependencies (#21881) 2022-11-22 08:58:55 +08:00
routers Improvements for Content Copy (#21842) 2022-11-21 17:59:42 +08:00
services Replace yaml.v2 with yaml.v3 (#21832) 2022-11-21 16:36:59 +08:00
snap switch to node18 for snapcraft 2022-08-18 12:25:50 -04:00
templates Webhook list enhancements (#21893) 2022-11-22 07:10:42 +08:00
tests Replace yaml.v2 with yaml.v3 (#21832) 2022-11-21 16:36:59 +08:00
tools Remove legacy `+build:` constraint (#19582) 2022-05-02 23:22:45 +08:00
web_src Update JS dependencies (#21881) 2022-11-22 08:58:55 +08:00
.air.toml Fix `make watch` for generated files (#20794) 2022-08-14 22:22:09 +01: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 Update JS dependencies (#21881) 2022-11-22 08:58:55 +08:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update JS dependencies (#21881) 2022-11-22 08:58:55 +08: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 Add sqlite vscode extension to Gitpod configuration (#21552) 2022-10-24 16:55:59 -04:00
.golangci.yml Simplify fmt-check (#21458) 2022-10-16 16:11:17 +08: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 Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Update JS dependencies and misc tweaks (#21583) 2022-10-28 09:40:50 -04:00
BSDmakefile Add BSDmakefile to prevent errors when `make` is called under FreeBSD (#4446) 2018-07-16 20:45:51 +02:00
CHANGELOG.md 1.17.3 changelog 2022-10-15 22:03:59 -04:00
CONTRIBUTING.md Add wording about keeping PRs up-to-date in CONTRIBUTING.md (#21468) 2022-10-15 12:41:24 -04:00
DCO follow the advisor: add DCO and some improvements 2016-11-04 16:43:41 +08:00
Dockerfile Switch to building with go1.19 (#20695) 2022-08-07 12:25:03 -04:00
Dockerfile.rootless Switch to building with go1.19 (#20695) 2022-08-07 12:25:03 -04:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
MAINTAINERS Remove Gusted as Gitea maintainer (#21676) 2022-11-03 19:34:24 -05:00
Makefile Consolidate security-check into checks-backend (#21882) 2022-11-21 10:39:00 +08:00
README.md Add cynkra bronze sponsor (#21325) 2022-10-13 21:44:04 -04:00
README_ZH.md Refactor Gitpod configuration to improve quick spin up of automated dev environments (#21411) 2022-10-12 12:17:04 -04:00
SECURITY.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
build.go Remove legacy `+build:` constraint (#19582) 2022-05-02 23:22:45 +08:00
go.mod Replace yaml.v2 with yaml.v3 (#21832) 2022-11-21 16:36:59 +08:00
go.sum Upgrade golang.org/x/crypto (#21792) 2022-11-12 22:14:35 -06:00
main.go Fix typo overrided -> overridden (#20687) 2022-08-06 20:54:26 -04:00
package-lock.json Update JS dependencies (#21881) 2022-11-22 08:58:55 +08:00
package.json Update JS dependencies (#21881) 2022-11-22 08:58:55 +08:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
vitest.config.js Remove vitest globals (#21505) 2022-10-19 14:50:19 +08:00
webpack.config.js Update JS dependencies (#21881) 2022-11-22 08:58:55 +08: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