Commit Graph
53 Commits
Author SHA1 Message Date
silverwind 424c481e19 docs: drop the gc.reflogExpire default (#584)
Gitea no longer sets `gc.reflogExpire`, leaving reflog expiry to git's defaults, see https://github.com/go-gitea/gitea/pull/39703, backported in https://github.com/go-gitea/gitea/pull/39711.

Reviewed-on: https://gitea.com/gitea/docs/pulls/584
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-10-10 16:56:06 +00:00
silverwind e4cad3c2e8 docs: update session providers and cookie names (#572)
Docs for https://github.com/go-gitea/gitea/pull/39504, which removed the `mysql`, `postgres`, `couchbase` and `memcache` session providers and renamed the default cookies to `gitea_session` and `gitea_remember`. The English cheat sheet copies the `app.example.ini` wording, the zh-cn and zh-tw cheat sheets get the same values.

Reviewed-on: https://gitea.com/gitea/docs/pulls/572
Reviewed-by: Lunny Xiao <[email protected]>
Reviewed-by: wxiaoguang <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-10-02 20:58:18 +00:00
silverwind 7219c0e44d docs: fix the REPOSITORY_AVATAR_FALLBACK_IMAGE default (#569)
The cheat sheet lists `/img/repo_default.png` as the `REPOSITORY_AVATAR_FALLBACK_IMAGE` default, but public files moved under `/assets` in Gitea 1.15 (https://github.com/go-gitea/gitea/pull/15219), so that path 404s. Like `app.example.ini` in https://github.com/go-gitea/gitea/pull/39514, document the default as empty, falling back to Gitea's builtin repository avatar, and note that a custom value is used as-is without the sub-path. Applies to all documented versions and translations.

_Written by Claude Code (Opus 5.5)._

Reviewed-on: https://gitea.com/gitea/docs/pulls/569
Reviewed-by: wxiaoguang <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-10-01 08:28:50 +00:00
silverwind 4a0ef0480b docs: update the SSH_SERVER_HOST_KEYS default and generated keys (#566)
Since https://github.com/go-gitea/gitea/pull/33974 (1.27), `SSH_SERVER_HOST_KEYS` defaults to `ssh/gitea.rsa, ssh/gitea.ed25519, ssh/gitea.ecdsa, ssh/gogs.rsa`. When none of the keys exist, Gitea generates 4096 bit RSA, 256 bit ECDSA and ED25519 keys instead of RSA alone. This updates next, 28 and 1.27 in all three languages, matching https://github.com/go-gitea/gitea/pull/39500.

Written by Claude.

Reviewed-on: https://gitea.com/gitea/docs/pulls/566
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-09-30 23:34:35 +00:00
6934d56056 docs: document egress modes and host lists (#557)
Documents the settings changed by https://github.com/go-gitea/gitea/pull/39426: `EGRESS_MODE`, the `[migrations]` `ALLOWED_HOST_LIST`/`BLOCKED_HOST_LIST` replacing `ALLOWED_DOMAINS`, `BLOCKED_DOMAINS` and `ALLOW_LOCALNETWORKS`, and the host list syntax with ports, CGNAT and reserved addresses. Also fixes the `socks://` examples, Go only speaks `socks5://`.

_Written by Claude._

---------

Co-authored-by: Lunny Xiao <[email protected]>
Co-authored-by: TheFox0x7 <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/557
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-09-30 11:42:29 +00:00
silverwind c4caf767ad docs: document self:, builtin:, $/ and runner tracing (#553)
Documents the `self:` and `builtin:` action prefixes from https://github.com/go-gitea/gitea/pull/39358, https://gitea.com/gitea/runner/pulls/1233 and https://gitea.com/gitea/runner/pulls/871, workflow-relative `$/` actions, and the runner's OpenTelemetry tracing from https://gitea.com/gitea/runner/pulls/1206.

1. Trims the action resolution and `DEFAULT_ACTIONS_URL` docs to state each fact once.
1. Drops outdated runner content from the FAQ and design pages.
1. Syncs zh-cn and zh-tw, including a port of the token permissions page they now link to.

_Written by Claude._

Reviewed-on: https://gitea.com/gitea/docs/pulls/553
Reviewed-by: bircni <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-09-25 02:51:09 +00:00
silverwind 779acd1cb9 docs: document NOTICE_ON_SUCCESS for every cron task (#552)
Several cron tasks in the cheat sheet listed `ENABLE_SUCCESS_NOTICE` or `NO_SUCCESS_NOTICE`. Gitea reads neither, only `NOTICE_ON_SUCCESS`. `NO_SUCCESS_NOTICE` was removed in https://github.com/go-gitea/gitea/pull/19221.

1. Replace both dead keys with `NOTICE_ON_SUCCESS` (default `false`).
2. Fix "Notice if not success" descriptions, which inverted the key's meaning.
3. List the key for `cleanup_hook_task_table`, `cleanup_actions`, `cleanup_action_runs` and `gc_lfs`, which honor it but omitted it.

Matches https://github.com/go-gitea/gitea/pull/39352.

Written by Claude.

Reviewed-on: https://gitea.com/gitea/docs/pulls/552
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: silverwind <[email protected]>
2026-09-18 23:53:53 +00:00
kmiitandLunny Xiao 1a284521f1 docs: Sync zh-cn and zh-tw current and 1.27 with English (#545)
Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/545
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: kmiit <[email protected]>
2026-09-14 19:50:42 +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]>
Co-authored-by: silverwind <[email protected]>
2026-08-05 22:50:38 +00:00
Lunny Xiao f47fdce6c8 chore: update path (#486)
Fix #34

Reviewed-on: https://gitea.com/gitea/docs/pulls/486
Reviewed-by: silverwind <[email protected]>
Co-authored-by: Lunny Xiao <[email protected]>
2026-08-03 15:39:27 +00:00
TheFox0x7andLunny Xiao 74674a6259 backport v27 changes (#471)
See https://github.com/go-gitea/gitea/issues/38621

---------

Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/471
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: TheFox0x7 <[email protected]>
2026-07-26 05:20:08 +00:00
Lunny Xiao 6a3f75f060 sync customizing gitea (#458)
Reviewed-on: https://gitea.com/gitea/docs/pulls/458
2026-07-08 04:58:43 +00:00
Zettat123andLunny 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]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/447
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: Zettat123 <[email protected]>
Co-committed-by: Zettat123 <[email protected]>
2026-06-28 09:32:51 +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]>
Co-authored-by: Zettat123 <[email protected]>
Co-committed-by: Zettat123 <[email protected]>
2026-05-28 17:29:35 +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]>
Co-authored-by: silverwind <[email protected]>
Co-committed-by: silverwind <[email protected]>
2026-05-04 11:38:21 +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]>
Co-authored-by: Zettat123 <[email protected]>
Co-committed-by: Zettat123 <[email protected]>
2026-04-25 18:25:14 +00:00
silverwind 128cbae023 Sync zh-cn/zh-tw config cheat sheet with English (#381)
Sync the zh-cn and zh-tw `config-cheat-sheet.md` translations with the English source for current and 1.26 versions.

Changes:
- Add 17 missing sections (`qos`, `mailer.override_header`, `markup.external-render-name`, `lfs_client`, `storage_minio`, `storage_azureblob`, `storage_override`, and 10 cron task subsections including the `Actions` cron tasks group)
- Add ~30 missing individual settings across existing sections
- Restructure storage sections to match English (separate Minio/Azure/Override subsections)
- Remove stale settings (`TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`, old inline MINIO duplicates, removed git timeout settings)
- Fix `MERMAID_MAX_SOURCE_CHARACTERS` default value (5000 -> 50000)
- Replace full-width Unicode punctuation (U+FF1A, U+FF08, U+FF09) with ASCII equivalents

All 4 i18n files now have 745 settings matching the English source.

---
This PR was written with the help of Claude Opus 4.6

Reviewed-on: https://gitea.com/gitea/docs/pulls/381
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: silverwind <[email protected]>
Co-committed-by: silverwind <[email protected]>
2026-04-10 17:39:20 +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]>
Co-authored-by: silverwind <[email protected]>
Co-committed-by: silverwind <[email protected]>
2026-04-10 16:50:43 +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]>
Co-authored-by: Zettat123 <[email protected]>
Co-committed-by: Zettat123 <[email protected]>
2026-03-01 19:00:35 +00:00
gabriel_radureauandLunny Xiao 98a7ea3f53 correct mentionned "gitea-repositories" directory with actual folder "repositories" (#266)
The mentionned gitea-repositories folder doesn't exist in the recent version. Correct it to the existing repositories folder.

Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/266
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: gabriel_radureau <[email protected]>
Co-committed-by: gabriel_radureau <[email protected]>
2025-11-20 22:09:30 +00:00
Lunny Xiao dcb9b9b450 Use category instead of place holder markdown file as directory (#299)
Reviewed-on: https://gitea.com/gitea/docs/pulls/299
2025-11-20 18:02:34 +00:00
baikuarch 3eda094305 更新 i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md (#272)
Reviewed-on: https://gitea.com/gitea/docs/pulls/272
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: baikuarch <[email protected]>
Co-committed-by: baikuarch <[email protected]>
2025-09-06 00:57:20 +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]>
Co-authored-by: wxiaoguang <[email protected]>
Co-committed-by: wxiaoguang <[email protected]>
2025-04-21 23:10:45 +00:00
wxiaoguang f29075ebeb Update ROOT_URL document (#210)
Reviewed-on: https://gitea.com/gitea/docs/pulls/210
Reviewed-by: hiifong <[email protected]>
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: wxiaoguang <[email protected]>
Co-committed-by: wxiaoguang <[email protected]>
2025-04-20 23:35:21 +00:00
appleboy dbfa0ba454 docs: add zh-tw folder (#195)
Signed-off-by: appleboy <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/195
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: appleboy <[email protected]>
Co-committed-by: appleboy <[email protected]>
2025-04-04 23:28:16 +00:00
techknowlogick 52933671d8 use docker.gitea.com docker URLs (#175)
Reviewed-on: https://gitea.com/gitea/docs/pulls/175
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: techknowlogick <[email protected]>
Co-committed-by: techknowlogick <[email protected]>
2025-02-28 15:36:37 +00:00
Zettat123 a97908040d Update some docs (#144)
Close #143

- Add `ORG_PAGING_NUM`
- Remove `hashFiles` from unsupported workflows syntax

Reviewed-on: https://gitea.com/gitea/docs/pulls/144
Reviewed-by: techknowlogick <[email protected]>
Co-authored-by: Zettat123 <[email protected]>
Co-committed-by: Zettat123 <[email protected]>
2025-01-09 05:27:03 +00:00
wxiaoguangandLunny Xiao 5c11efcedf Improve config cheat sheet and update SSH_USER (#138)
Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/138
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: wxiaoguang <[email protected]>
Co-committed-by: wxiaoguang <[email protected]>
2025-01-07 22:40:06 +00:00
dc5a65d91a fix: add space for url (#129)
![image.png](/attachments/cb407e73-014e-41d5-be43-2571f1dfcde1)

Resolve the problem that was wrongly detected as a URL.

Co-authored-by: shugen002 <[email protected]>
Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/129
Reviewed-by: blumia <[email protected]>
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: shugen <[email protected]>
Co-committed-by: shugen <[email protected]>
2024-12-19 20:33:24 +00:00
wxiaoguangandLunny Xiao 177b9d8d87 Add ALLOW_FORK_INTO_SAME_OWNER and fix legacy syntax (#122)
Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/122
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: wxiaoguang <[email protected]>
Co-committed-by: wxiaoguang <[email protected]>
2024-12-18 07:20:36 +00:00
TheFox0x7 7a4e79c937 use fqin for container images (#125)
It's generally considered a better practice and it's more portable allowing podman to work without having to modify the name.

Reviewed-on: https://gitea.com/gitea/docs/pulls/125
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: TheFox0x7 <[email protected]>
Co-committed-by: TheFox0x7 <[email protected]>
2024-12-17 20:23:46 +00:00
Lunny Xiao fc7bdfc7b6 Improve the signing documentations (#108)
Reviewed-on: https://gitea.com/gitea/docs/pulls/108
2024-11-25 05:36:44 +00:00
Lunny Xiao ddc1db3637 Move authentication from usage to administration (#105)
Reviewed-on: https://gitea.com/gitea/docs/pulls/105
2024-11-24 02:32:42 +00:00
wxiaoguang 79767d83a7 Update ALLOWED_TYPES (#96)
Reviewed-on: https://gitea.com/gitea/docs/pulls/96
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: wxiaoguang <[email protected]>
Co-committed-by: wxiaoguang <[email protected]>
2024-11-15 05:53:35 +00:00
Zettat123andLunny Xiao 5e9c955979 Add DEFAULT_MIRROR_REPO_UNITS and DEFAULT_TEMPLATE_REPO_UNITS options (#91)
Related to https://github.com/go-gitea/gitea/pull/32416

Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/91
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: Zettat123 <[email protected]>
Co-committed-by: Zettat123 <[email protected]>
2024-11-13 00:26:38 +00:00
Zettat123 0c55d89c91 update cn docs 2024-10-18 09:55:29 +08:00
Lunny Xiao bea0fb7387 Use camo.Always instead of camo.Allways (#73)
ref: https://github.com/go-gitea/gitea/pull/32097
Reviewed-on: https://gitea.com/gitea/docs/pulls/73
2024-09-25 17:11:33 +00:00
Jason Song d9cc7c43c0 Enable compression for Actions logs by default (#66)
Follow https://github.com/go-gitea/gitea/pull/32013

Reviewed-on: https://gitea.com/gitea/docs/pulls/66
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: Jason Song <[email protected]>
Co-committed-by: Jason Song <[email protected]>
2024-09-10 02:32:33 +00:00
Lunny Xiao 97339dc250 Remove unnecessary _index.md 2024-09-02 17:57:43 -07:00
Lunny Xiao 1f23956442 replace all global variables with right value 2024-08-31 23:14:38 -07:00
Lunny Xiao 5ecafa9a56 Fix outdated cheat sheet about ALLOWED_DOMAINS (#55)
Reviewed-on: https://gitea.com/gitea/docs/pulls/55
Reviewed-by: yp05327 <[email protected]>
2024-08-22 04:09:23 +00:00
Jason Song 4d7c41947b Add LOG_COMPRESSION (#50)
Follow https://github.com/go-gitea/gitea/pull/31761

Reviewed-on: https://gitea.com/gitea/docs/pulls/50
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: Jason Song <[email protected]>
Co-committed-by: Jason Song <[email protected]>
2024-08-09 16:24:28 +00:00
Lunny Xiao eebb6b1528 Add storage configuration hint to simplify the configuration (#44)
Reviewed-on: https://gitea.com/gitea/docs/pulls/44
2024-08-09 02:29:24 +00:00
Lunny Xiao b7d3335676 Add more description for LFS_JWT_SECRET (#46)
Fix https://github.com/go-gitea/gitea/issues/22727

Reviewed-on: https://gitea.com/gitea/docs/pulls/46
2024-08-07 01:51:54 +00:00
Lunny Xiao af22422e1a Update meta data of docs 2024-08-06 16:44:42 -07:00
Jason Song 56e120e1d8 Add LOG_RETENTION_DAYS (#40)
Related to https://github.com/go-gitea/gitea/pull/31735

Reviewed-on: https://gitea.com/gitea/docs/pulls/40
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: Jason Song <[email protected]>
Co-committed-by: Jason Song <[email protected]>
2024-08-02 03:33:18 +00:00
zeauwandLunny Xiao 5df20429a2 docs(reverse-proxies.md): Update zh-cn translation of reverse-proxies.md (#29)
Update the zh-cn translation of reverse-proxies.md of current version and version 1.22 (since reverse-proxies.md of them are same). The translation is based on English version of reverse-proxies.md of current version.

Resolve [issue 24](https://gitea.com/gitea/docs/issues/24)

Co-authored-by: Lunny Xiao <[email protected]>
Reviewed-on: https://gitea.com/gitea/docs/pulls/29
Reviewed-by: Lunny Xiao <[email protected]>
Co-authored-by: zeauw <[email protected]>
Co-committed-by: zeauw <[email protected]>
2024-07-17 03:08:53 +00:00
Lunny Xiao 7e77e7fb39 Add missing doc from main repository (#4)
Copy from https://github.com/go-gitea/gitea/pull/31211/files
Author: @MaxWipfli

Add missing documentation for https://github.com/go-gitea/gitea/pull/30268

Reviewed-on: https://gitea.com/gitea/docs/pulls/4
2024-06-15 03:10:51 +00:00
Lunny Xiao ab2cdde840 Fix more links and problems (#3)
Reviewed-on: https://gitea.com/gitea/docs/pulls/3
2024-06-14 08:53:10 +00:00
Lunny Xiao 9a8396aa29 Fix broken links (#1)
- Always use a relative markdown link so that we can jump even if we edit it in local env or read it in code hosting server.

Reviewed-on: https://gitea.com/gitea/docs/pulls/1
2024-06-14 05:53:15 +00:00