bircni
a018c73100
docs: Document audit logging
2026-09-12 13:21:33 +02:00
wxiaoguang
87703aec80
Remove "experimental" comment from "ALLOW_FORK_INTO_SAME_OWNER" ( #530 )
...
https://github.com/go-gitea/gitea/pull/39088
Reviewed-on: https://gitea.com/gitea/docs/pulls/530
Reviewed-by: silverwind <[email protected] [email protected]
2026-08-25 17:33:20 +00:00
18bd085607
docs(actions): document RUN_RETENTION_DAYS and sync the retention descriptions ( #502 )
...
Documents `RUN_RETENTION_DAYS` and copies all three Actions retention descriptions verbatim from `app.example.ini`, so the cheat sheet no longer drifts from the config.
Reference https://github.com/go-gitea/gitea/pull/38855
Description written by Claude (Opus 5).
---------
Co-authored-by: bircni <[email protected] [email protected] [email protected] https://gitea.com/gitea/docs/pulls/502
Reviewed-by: silverwind <[email protected] [email protected]
2026-08-22 21:50:48 +00:00
Lunny Xiao
106a813e08
docs: postgres example version, SELinux, OAuth2/OIDC, IIS host rewrite and ACME in containers ( #513 )
...
Five documentation fixes that do not depend on anything upstream.
**PostgreSQL version in the docker guide** (closes #224 )
The compose example pinned `postgres:14`, the oldest version Gitea still tests against, and PostgreSQL does not upgrade its data directory on its own, so every new deployment that copies the example is one major upgrade behind from day one. The example now uses `postgres:18`, with a note about why the major version is pinned and a pointer to the supported range.
**SELinux** (closes #211 )
`setcap 'cap_net_bind_service=+ep'` is what the docs suggest for binding to a port below 1024, but it is denied under SELinux depending on the label of the binary, and it is lost on every upgrade because the capability lives in an extended attribute of the file. A new page describes granting the capability through the systemd unit instead (`AmbientCapabilities`, plus `PrivateUsers=false` when the sandboxing gets in the way), the `semanage fcontext` / `restorecon` labels for the binary and the data directory, and how to read the denials with `ausearch` and `audit2allow`. It is linked from the binary and source installation pages and from the `gitea web` notes.
**OAuth2 and OpenID Connect** (closes #106 )
The authentication page documented LDAP, PAM, SMTP, FreeIPA, SPNEGO and the reverse proxy, but not that Gitea can log users in against an external OAuth2 or OpenID Connect provider, which made it look like the only OAuth2 support is Gitea acting as the provider. The new section covers the fields of the authentication source, the callback URL to register at the provider, the group and claim mappings, and the `[oauth2_client]` settings, and separates it from the older OpenID 2.0 sign-in.
**IIS reverse proxy** (closes #39 )
Application Request Routing rewrites the host of the `Location` header back to the internal one while "Reverse rewrite host in response headers" is on, which sends the browser to `127.0.0.1:3000` after a sign-in. The IIS section now says to turn it off and where the setting lives.
**ACME in containers** (closes #292 )
`ACME_DIRECTORY` defaults to the relative path `https`, which is resolved against the working directory of the process. In the official image that is `/app/gitea`, outside the `/data` volume, so a recreated container asks the CA for a new certificate and runs into the Let's Encrypt limit of 5 certificates per week for the same domains. The HTTPS page now warns about it and shows an absolute path inside the volume; the cheat sheet entry points at the warning. The default itself is being changed in https://github.com/go-gitea/gitea/pull/35851 , the note stays useful for every released version.
Only `docs/` is touched, the released versions keep their content.
<!-- cloudflare-preview --> Preview: https://pr-513.docs-gitea-com.pages.dev
Reviewed-on: https://gitea.com/gitea/docs/pulls/513
Reviewed-by: bircni <[email protected] [email protected]
2026-08-15 09:18:00 +00:00
bircni and Lunny Xiao
1b19b19397
docs: Add Gitea-app to DEFAULT_APPLICATIONS ( #505 )
...
<!-- cloudflare-preview --> Preview: https://pr-505.docs-gitea-com.pages.dev
---------
Co-authored-by: Lunny Xiao <[email protected] https://gitea.com/gitea/docs/pulls/505
Reviewed-by: TheFox0x7 <[email protected]
2026-08-12 21:20:24 +00:00
bircni and Lunny Xiao
08fcd3007c
docs: add DEFAULT_OBJECT_FORMAT option to configuration cheat sheet ( #504 )
...
https://github.com/go-gitea/gitea/pull/38877
Co-authored-by: Lunny Xiao <[email protected] https://gitea.com/gitea/docs/pulls/504
Reviewed-by: wxiaoguang <[email protected]
2026-08-12 21:19:28 +00:00
Erik Bloß
c78e0d42a9
docs(cron): fix incorrect descriptions ( #503 )
...
Signed-off-by: Erik Bloß <[email protected] https://gitea.com/gitea/docs/pulls/503
Reviewed-by: Lunny Xiao <[email protected] [email protected]
2026-08-12 06:36:59 +00:00
silverwind and Lunny Xiao
9d06e8ea59
docs: replace the removed duoshuo gravatar source ( #499 )
...
`GRAVATAR_SOURCE = duoshuo` is removed in Gitea 1.28, that service shut down in 2017. `libravatar` is a long-standing alias that was never documented.
Matches the wording in `custom/conf/app.example.ini`.
Gitea PR: https://github.com/go-gitea/gitea/pull/38843
Written by Claude Code (Opus 5).
---------
Co-authored-by: Lunny Xiao <[email protected] https://gitea.com/gitea/docs/pulls/499
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-08-10 22:53:49 +00:00
silverwind
b11dbbc961
Update TLS settings docs ( #489 )
...
Update for https://github.com/go-gitea/gitea/pull/38687 .
Reviewed-on: https://gitea.com/gitea/docs/pulls/489
Reviewed-by: techknowlogick <[email protected] [email protected]
2026-08-05 22:50:38 +00:00
5581d6d273
Document shared [redis] section (config cheat sheet) ( #468 )
...
Documents the shared `[redis]` section added in https://github.com/go-gitea/gitea/pull/38550 : a single `CONN_STR` that redis-backed subsystems (`[cache]`, `[session]`, `[queue]`, `[global_lock]`) fall back to when their own connection string is empty, with per-subsystem values always taking precedence.
Adds the new section plus one fallback note in the existing Queue/Cache/Session entries.
Note for maintainers: best merged together with (or after) [go-gitea/gitea#38550 ](https://github.com/go-gitea/gitea/pull/38550 ).
---------
Co-authored-by: silverwind <[email protected] [email protected] https://gitea.com/gitea/docs/pulls/468
Reviewed-by: silverwind <[email protected] [email protected]
2026-07-24 08:15:18 +00:00
TheFox0x7
985e2239ef
update cheatsheet ( #461 )
...
Reviewed-on: https://gitea.com/gitea/docs/pulls/461
Reviewed-by: Lunny Xiao <[email protected] [email protected]
2026-07-10 20:04:19 +00:00
20c924ddb6
docs: add note on environment variable formatting in case of special characters ( #425 )
...
Added information to explain to the user what to do when sections contain special characters such as `.` and `-`
---------
Co-authored-by: Lunny Xiao <[email protected] [email protected] https://gitea.com/gitea/docs/pulls/425
Reviewed-by: Lunny Xiao <[email protected] [email protected]
2026-07-09 23:51:10 +00:00
bircni and Lunny Xiao
938700805b
docs: clarify that [git.config] options override Gitea's built-in defaults ( #444 )
...
User-provided git config options are now applied after Gitea's built-in
defaults, so they take precedence. Update the config cheat sheet to
reflect this new behavior and add a warning about potentially breaking
git operations.
refers to https://github.com/go-gitea/gitea/pull/38172
---------
Co-authored-by: Lunny Xiao <[email protected] https://gitea.com/gitea/docs/pulls/444
Reviewed-by: Lunny Xiao <[email protected] [email protected]
2026-07-09 23:50:21 +00:00
965c269495
Update zh tw languages and fix some broken links ( #455 )
...
---------
Co-authored-by: silverwind <[email protected] [email protected] https://gitea.com/gitea/docs/pulls/455
Reviewed-by: silverwind <[email protected]
2026-07-09 23:41:46 +00:00
wxiaoguang
7fa4bc6bd4
update config: DEFAULT_TITLE_SOURCE=branch-name ( #457 )
...
https://github.com/go-gitea/gitea/pull/38356Reviewed-on : https://gitea.com/gitea/docs/pulls/457
Reviewed-by: Lunny Xiao <[email protected] [email protected]
2026-07-07 18:40:24 +00:00
Zettat123 and Lunny Xiao
1fb481c186
docs: add docs for scoped workflows ( #447 )
...
Related: https://github.com/go-gitea/gitea/pull/38154
---------
Co-authored-by: Lunny Xiao <[email protected] https://gitea.com/gitea/docs/pulls/447
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-06-28 09:32:51 +00:00
wxiaoguang
88f92b0698
Add CONTENT_SECURITY_POLICY_GENERAL ( #434 )
...
Reviewed-on: https://gitea.com/gitea/docs/pulls/434
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-06-12 01:27:20 +00:00
Zettat123
95106c08e9
docs: split MAX_CREATION_LIMIT into USER_MAX_CREATION_LIMIT and ORG_MAX_CREATION_LIMIT ( #427 )
...
Related https://github.com/go-gitea/gitea/pull/37872
Reviewed-on: https://gitea.com/gitea/docs/pulls/427
Reviewed-by: Nicolas <[email protected] [email protected] [email protected]
2026-05-28 17:29:35 +00:00
wxiaoguang
478059a7ed
Update SSH_PORT comment
2026-05-27 06:01:42 +00:00
wxiaoguang
8b31adbc6f
fix: make DEFAULT_TITLE_SOURCE default to auto
2026-05-19 08:07:42 +00:00
wxiaoguang
b6b8dbcc64
Update SQLITE_TIMEOUT ( #419 )
...
Reviewed-on: https://gitea.com/gitea/docs/pulls/419
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-05-07 12:59:34 +00:00
silverwind
5bab08db10
Note OpenSearch compatibility for elasticsearch indexer ( #417 )
...
https://github.com/go-gitea/gitea/pull/37411
---
This PR was written with the help of Claude Opus 4.7
Reviewed-on: https://gitea.com/gitea/docs/pulls/417
Reviewed-by: Nicolas <[email protected] [email protected] [email protected]
2026-05-04 11:38:21 +00:00
f550d33ad7
Update SSH_ROOT_PATH / attachment comment ( #373 )
...
Co-authored-by: Lunny Xiao <[email protected] [email protected] https://gitea.com/gitea/docs/pulls/373
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-04-28 21:56:14 +00:00
0xGREG and Nicolas
e0fcc861f2
Document DEFAULT_TITLE_SOURCE pull request title setting ( #391 )
...
Adds documentation for the `DEFAULT_TITLE_SOURCE` setting.
- Added `DEFAULT_TITLE_SOURCE` to the config cheat sheet under `[repository.pull-request]`
- Added a "Default pull request title" section to the pull request usage docs explaining both modes (`first-commit` and `auto`)
---------
Co-authored-by: Nicolas <[email protected] https://gitea.com/gitea/docs/pulls/391
Reviewed-by: Nicolas <[email protected] [email protected] [email protected]
2026-04-28 21:45:22 +00:00
Zettat123
3ef08b184a
Add MAX_RERUN_ATTEMPTS to config cheat sheet ( #383 )
...
Related https://github.com/go-gitea/gitea/pull/37119
Reviewed-on: https://gitea.com/gitea/docs/pulls/383
Reviewed-by: Nicolas <[email protected] [email protected] [email protected]
2026-04-25 18:25:14 +00:00
silverwind and wxiaoguang
58d5c6c5e3
Add X_CONTENT_TYPE_OPTIONS ( #389 )
...
https://github.com/go-gitea/gitea/pull/37354
---
This PR was written with the help of Claude Opus 4.7
---------
Co-authored-by: wxiaoguang <[email protected] https://gitea.com/gitea/docs/pulls/389
Reviewed-by: wxiaoguang <[email protected] [email protected] [email protected]
2026-04-24 10:54:21 +00:00
wxiaoguang
76b9c25b6d
Add CUSTOM_SCHEMES ( #387 )
...
https://github.com/go-gitea/gitea/pull/37356
Reviewed-on: https://gitea.com/gitea/docs/pulls/387
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-04-22 22:10:57 +00:00
silverwind
59bd79347e
Document REVERSE_PROXY_LOGOUT_REDIRECT setting ( #380 )
...
Add documentation for the new `REVERSE_PROXY_LOGOUT_REDIRECT` setting in the `[security]` section, which allows redirecting users to an external URL or relative path after logout when using reverse proxy authentication.
For Gitea 1.26, ref https://github.com/go-gitea/gitea/pull/36085 .
---
This PR was written with the help of Claude Opus 4.6
Reviewed-on: https://gitea.com/gitea/docs/pulls/380
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-04-10 16:50:43 +00:00
TheFox0x7
1568bfa1e9
terraform state registry docs ( #357 )
...
https://github.com/go-gitea/gitea/pull/36710
Reviewed-on: https://gitea.com/gitea/docs/pulls/357
Reviewed-by: Nicolas <[email protected] [email protected] [email protected]
2026-04-06 20:41:42 +00:00
TheFox0x7
8660c68d8c
add actions cron tasks ( #371 )
...
fixes: https://github.com/go-gitea/gitea/issues/37009 for docs
Reviewed-on: https://gitea.com/gitea/docs/pulls/371
Reviewed-by: Nicolas <[email protected] [email protected] [email protected]
2026-03-27 23:38:53 +00:00
wxiaoguang
9a00f8ea0c
Sync docs/administration/config-cheat-sheet.md ( #368 )
...
Reviewed-on: https://gitea.com/gitea/docs/pulls/368
Reviewed-by: silverwind <[email protected] [email protected] [email protected]
2026-03-24 15:44:11 +00:00
silverwind
47ef41da3b
Add DEFAULT_DELETE_BRANCH_AFTER_MERGE to config cheat sheet ( #367 )
...
Add documentation for the new `[repository.pull-request]` `DEFAULT_DELETE_BRANCH_AFTER_MERGE` config option added in https://github.com/go-gitea/gitea/pull/36917 .
*This comment was written by Claude.*
Reviewed-on: https://gitea.com/gitea/docs/pulls/367
Reviewed-by: TheFox0x7 <[email protected] [email protected] [email protected]
2026-03-23 19:12:49 +00:00
silverwind
eb8ade10c7
Update environment variable docs, remove environment-to-ini references ( #355 )
...
The standalone `environment-to-ini` tool was removed in https://github.com/go-gitea/gitea/pull/35735 and its functionality is now built into the Gitea binary. This PR:
- Removes outdated links to the removed `contrib/environment-to-ini` directory
- Updates the "Use environment variables to setup Gitea" section in the config cheat sheet
- Adds examples showing how env vars map to `app.ini` settings and the `__FILE` suffix for secrets
*This PR was authored by Claude.*
Reviewed-on: https://gitea.com/gitea/docs/pulls/355
Reviewed-by: wxiaoguang <[email protected] [email protected]
2026-03-17 18:19:18 +00:00
Zettat123
dc136aa31b
Add never option to PUBLIC_URL_DETECTION configuration ( #353 )
...
https://github.com/go-gitea/gitea/pull/36785
Reviewed-on: https://gitea.com/gitea/docs/pulls/353
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-03-01 19:00:35 +00:00
silverwind
44c6a0fa20
Move X_FRAME_OPTIONS from cors to security section ( #349 )
...
## Summary
- Move `X_FRAME_OPTIONS` setting from `[cors]` to `[security]` section in the config cheat sheet
- Document the new `unset` value option and clarify the header applies to web responses only
Ref: https://github.com/go-gitea/gitea/pull/30256
Reviewed-on: https://gitea.com/gitea/docs/pulls/349
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-02-22 20:27:19 +00:00
TheFox0x7
d26bbc9794
add new config options for releases ( #348 )
...
https://github.com/go-gitea/gitea/pull/36697
Reviewed-on: https://gitea.com/gitea/docs/pulls/348
Reviewed-by: wxiaoguang <[email protected] [email protected] [email protected] [email protected]
2026-02-22 07:39:17 +00:00
silverwind
84bc4f138d
Add actions.WORKFLOW_DIRS setting to config cheat sheet ( #347 )
...
Add documentation for the new `actions.WORKFLOW_DIRS` setting introduced in https://github.com/go-gitea/gitea/pull/36619 for v1.26.
Reviewed-on: https://gitea.com/gitea/docs/pulls/347
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-02-19 19:02:58 +00:00
silverwind
516a0af047
Add FOLDER_ICON_THEME ( #326 )
...
Available in 1.26 with https://github.com/go-gitea/gitea/pull/36496
Reviewed-on: https://gitea.com/gitea/docs/pulls/326
Co-authored-by: silverwind <[email protected] [email protected]
2026-02-02 15:50:25 +00:00
dosenpils
49cc18e096
fixed broken link ( #322 )
...
There's a broken link in the documentation in the chapter [Use environment variables to setup Gitea](https://docs.gitea.com/administration/config-cheat-sheet#use-environment-variables-to-setup-gitea ) (Docs >> Administration >> Configuration Cheat Sheet).
This pull requests will fix this.
Reviewed-on: https://gitea.com/gitea/docs/pulls/322
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2026-01-21 01:55:21 +00:00
wxiaoguang
8550cc4de1
remove unused git timeout config options
2026-01-21 01:36:27 +00:00
silverwind
18d05903c7
Add DIFF_RENAME_SIMILARITY_THRESHOLD ( #316 )
...
Co-authored-by: silverwind <[email protected] [email protected]
2025-12-17 10:57:54 +00:00
dangjinghao
fd8beed04d
Fix formatting for Mailer.FROM address example in configuration cheat sheet ( #296 )
...
This example is incorrect.
wrong:
<img width="1058" alt="wrong-1.png" src="attachments/1cb3b95b-c3e4-4213-aeff-13e518021536">
<img width="442" alt="wrong-2.png" src="attachments/212aa79f-bbb7-457a-a0b8-fc7572f6d497">
<img width="1201" alt="wrong-3.png" src="attachments/32fde98a-d987-475c-9f88-d563c177ad24">
correct:
<img width="1034" alt="correct-1.png" src="attachments/b4993846-eec2-4e7c-8adc-11fc335216dc">
<img width="410" alt="correct-2.png" src="attachments/419ad32c-4080-462e-af5e-8fc9f63727a7">
Reviewed-on: https://gitea.com/gitea/docs/pulls/296
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2025-11-15 03:43:02 +00:00
wxiaoguang
12293b604e
Update docs/administration/config-cheat-sheet.md ( #285 )
...
Reviewed-on: https://gitea.com/gitea/docs/pulls/285
2025-10-25 03:47:14 +00:00
Johan Van de Wauw
c9bf137a23
Add TWO_FACTOR_AUTH documentation ( #273 )
...
Reviewed-on: https://gitea.com/gitea/docs/pulls/273
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2025-09-10 20:48:36 +00:00
641977c93a
Updated the docs and versioned_docs ( #253 )
...
This closes #251
Co-authored-by: karthik.bhandary <[email protected] [email protected] https://gitea.com/gitea/docs/pulls/253
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected] [email protected]
2025-07-28 19:46:12 +00:00
wxiaoguang
14d48e6834
Update PUBLIC_URL_DETECTION ( #212 )
...
https://github.com/go-gitea/gitea/pull/34250
Reviewed-on: https://gitea.com/gitea/docs/pulls/212
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2025-04-21 23:10:45 +00:00
Rowan Bohde and Lunny Xiao
c299483551
Add documentation for request prioritization middleware ( #208 )
...
This is the documentation side of https://github.com/go-gitea/gitea/pull/33951
Co-authored-by: Lunny Xiao <[email protected] https://gitea.com/gitea/docs/pulls/208
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2025-04-20 23:41:58 +00:00
wxiaoguang
f29075ebeb
Update ROOT_URL document ( #210 )
...
Reviewed-on: https://gitea.com/gitea/docs/pulls/210
Reviewed-by: hiifong <[email protected] [email protected] [email protected] [email protected]
2025-04-20 23:35:21 +00:00
wxiaoguang
cc53afc60e
Update MERMAID_MAX_SOURCE_CHARACTERS ( #202 )
...
Reviewed-on: https://gitea.com/gitea/docs/pulls/202
2025-04-09 07:58:18 +00:00
wxiaoguang
e3d58503ca
Add markdown usage ( #198 )
...
First simple version
Reviewed-on: https://gitea.com/gitea/docs/pulls/198
Reviewed-by: Lunny Xiao <[email protected] [email protected] [email protected]
2025-04-05 05:08:06 +00:00
bircni
wxiaoguang
Lunny Xiao
Erik Bloß
TheFox0x7
Zettat123andLunny Xiao
Zettat123
0xGREGandNicolas
TheFox0x7
dosenpils
wxiaoguang
dangjinghao
Johan Van de Wauw
Rowan BohdeandLunny Xiao
wxiaoguang