Commit Graph

95 Commits

Author SHA1 Message Date
Lunny Xiao
045ad3fd8c Add missing cron items content (#174)
Reviewed-on: https://gitea.com/gitea/docs/pulls/174
2025-02-25 20:13:15 +00:00
b-nagaj
540072fa39 FIX: DB Prep Docs - Step #1 (#173)
## Description

Fix step 1 of the [Database Preparation](https://docs.gitea.com/installation/database-prep) docs.

## Changes

When a user modifies the */etc/mysql/my.cnf* config file as instructed in step 1 of the database preparation guide, they get an error message from MySQL when trying to log in as the root user after saving changes.

```shell
mysql: [ERROR] Found option without preceding group in config file /etc/mysql/my.cnf at line 37.
mysql: [ERROR] Fatal error in defaults handling. Program aborted!
```
The solution is to include precede `bind-address` with a group like this.

```ini
[mysqld]
bind-address = 203.0.113.3
```

Reviewed-on: https://gitea.com/gitea/docs/pulls/173
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: b-nagaj <bryce.nagaj@proton.me>
Co-committed-by: b-nagaj <bryce.nagaj@proton.me>
2025-02-25 19:39:31 +00:00
Lunny Xiao
bbbb9091bf Update act runner status (#163)
Fix #162

Reviewed-on: https://gitea.com/gitea/docs/pulls/163
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-committed-by: Lunny Xiao <xiaolunwen@gmail.com>
2025-01-29 05:12:05 +00:00
Brandon Philips
59ef598b49 fix admin url for 1.23.0 (#164)
I am running the release candidate and found the admin URL changed.
https://github.com/go-gitea/gitea/pull/32189

Reviewed-on: https://gitea.com/gitea/docs/pulls/164
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.com>
Co-authored-by: Brandon Philips <brandon@ifup.org>
Co-committed-by: Brandon Philips <brandon@ifup.org>
2025-01-28 16:33:32 +00:00
99rgosse
b84e09cd7b Add the "--skip-index" parameter for dump command (#158)
Hello
This PR is only to show up the "--skip-index" parameter missing from the documentation from the "dump" command

Reference in code : https://github.com/go-gitea/gitea/blob/main/cmd/dump.go#L267

Reviewed-on: https://gitea.com/gitea/docs/pulls/158
Co-authored-by: 99rgosse <99rgosse@noreply.gitea.com>
Co-committed-by: 99rgosse <99rgosse@noreply.gitea.com>
2025-01-17 17:43:21 +00:00
woshishabii
56cbea7928 a typo i guess (#155)
Reviewed-on: https://gitea.com/gitea/docs/pulls/155
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: woshishabii <woshishabii@noreply.gitea.com>
Co-committed-by: woshishabii <woshishabii@noreply.gitea.com>
2025-01-16 00:16:26 +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 <techknowlogick@noreply.gitea.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
2025-01-09 05:27:03 +00:00
wxiaoguang
5c11efcedf Improve config cheat sheet and update SSH_USER (#138)
Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/138
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2025-01-07 22:40:06 +00:00
TheFox0x7
d97b557d9f Remove dead marketplace links (#139)
both have removed gitea from their marketplaces

Reviewed-on: https://gitea.com/gitea/docs/pulls/139
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2025-01-05 18:33:08 +00:00
hype8912
8433f055a1 Update docs/usage/actions/variables.md (#75)
Updated text to say action variables cannot not start with "CI"

Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/75
Co-authored-by: hype8912 <hype8912@noreply.gitea.com>
Co-committed-by: hype8912 <hype8912@noreply.gitea.com>
2024-12-27 00:47:29 +00:00
Lunny Xiao
ef66eb0882 Update storage docs to make less confusing (#131)
Reviewed-on: https://gitea.com/gitea/docs/pulls/131
Reviewed-by: Zettat123 <zettat123@noreply.gitea.com>
Reviewed-by: Bo-Yi Wu (吳柏毅) <appleboy.tw@gmail.com>
2024-12-27 00:12:07 +00:00
Zettat123
8f872a636d Document for GITEA_RUNNER_REGISTRATION_TOKEN env (#132)
Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/132
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
2024-12-24 20:32:57 +00:00
vmmello
57ee3a4653 FAQ: improves answer of question "Push Hook / Webhook / Actions aren't running" (#130)
On FAQ item: "Push Hook / Webhook / Actions aren't running"

The action suggested in the original answer is not enough to fix the issue when the hooks are not running. For example, when none of the hooks is running, and branches and tags are not in the database, re-running only the update/receive hooks will not have any effect.

This change adds two additional actions: sync branches and tags before running re-running the sync of update/receive hooks.

Also added a comment about filesystems mounted with `no-exec` option.

Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/130
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: vmmello <vmmello@noreply.gitea.com>
Co-committed-by: vmmello <vmmello@noreply.gitea.com>
2024-12-23 03:44:44 +00:00
wxiaoguang
177b9d8d87 Add ALLOW_FORK_INTO_SAME_OWNER and fix legacy syntax (#122)
Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/122
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2024-12-18 07:20:36 +00:00
TheFox0x7
43b15f49b7 Add a warning about sha256 support in actions (#126)
Closes: https://gitea.com/gitea/docs/issues/74

Reviewed-on: https://gitea.com/gitea/docs/pulls/126
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-12-18 02:18:37 +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 <lunny@noreply.gitea.com>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-12-17 20:23:46 +00:00
Lunny Xiao
2b9cc256ea Remove compare with Gogs because of the Gogs development is almost stopped (#124)
Reviewed-on: https://gitea.com/gitea/docs/pulls/124
Reviewed-by: Bo-Yi Wu (吳柏毅) <appleboy.tw@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-committed-by: Lunny Xiao <xiaolunwen@gmail.com>
2024-12-16 17:14:08 +00:00
KN4CK3R
6b1cd2beeb Add Arch package registry (#111)
Docs for https://github.com/go-gitea/gitea/pull/32692

Close #47

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/111
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
Co-committed-by: KN4CK3R <admin@oldschoolhack.me>
2024-12-07 04:15:16 +00:00
tobiasbp
9a204d82a1 Add info on STATIC_URL_PREFIX gotcha in cheat sheet (#99)
When using *STATIC_URL_PREFIX* to load assets, some UI elements will stop working, as described on the Gitea server on Discord: https://discord.com/channels/322538954119184384/322910365237248000/1305896452400218122

The fix is, to disable *ui.notification.EVENT_SOURCE_UPDATE_TIME* by setting it to *-1*.

This PR adds that information to the _configuration cheat sheet_.

The fix is needed in Gitea 1.22.3. I do not know about previous versions.

Co-authored-by: tobias.petersen <tobias.petersen@unity3d.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/99
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: tobiasbp <tobiasbp@noreply.gitea.com>
Co-committed-by: tobiasbp <tobiasbp@noreply.gitea.com>
2024-12-04 01:50:30 +00:00
wxiaoguang
e80ea3d8e7 doc: ENABLE_PASSWORD_LOGIN_FORM (#110)
Reviewed-on: https://gitea.com/gitea/docs/pulls/110
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2024-12-01 19:40:53 +00:00
pasmophobia
f857051cdc fix mistake in docs/usage/actions/act-runner.md#365 (#97)
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/97
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: pasmophobia <pasmophobia@noreply.gitea.com>
Co-committed-by: pasmophobia <pasmophobia@noreply.gitea.com>
2024-12-01 06:22:57 +00:00
mowoc-ocp
ed69343d70 Update docs/administration/config-cheat-sheet.md for MINIO_IAM_ENDPOINT (#103)
Targeting issue [#32271](https://github.com/go-gitea/gitea/issues/32271)

## Summary
This PR adds information about MINIO_IAM_ENDPOINT to the configuration cheat sheet, related to PR https://github.com/go-gitea/gitea/pull/32581

## Changes
- Adds MINIO_IAM_ENDPOINT to all examples referencing `MinioStorageConfig`

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/103
Co-authored-by: mowoc-ocp <mowoc-ocp@noreply.gitea.com>
Co-committed-by: mowoc-ocp <mowoc-ocp@noreply.gitea.com>
2024-11-26 08:03:34 +00:00
Konstantin Podsvirov
683e72aed1 Fix in delete debian package example (#98)
Delete extra `s` symbol in api entrypoint.

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/98
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Konstantin Podsvirov <podsvirov@noreply.gitea.com>
Co-committed-by: Konstantin Podsvirov <podsvirov@noreply.gitea.com>
2024-11-26 02:07:48 +00:00
Lunny Xiao
1edaf07b36 Update comparasion because of merge queue has been implemented. (#104)
Since https://github.com/go-gitea/gitea/pull/9307 and https://github.com/go-gitea/gitea/pull/19648, merge queue has been introduced.

Reviewed-on: https://gitea.com/gitea/docs/pulls/104
2024-11-25 21:10:09 +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
Marcell Mars
541fa954bb Enhancing Gitea OAuth2 Provider with Granular Scopes for Resource Access (#102)
The documentation update for enhancing the OAuth2 Provider with granular scopes for resource access includes a practical use case with step-by-step guidance supported by screenshots.

Doc for https://github.com/go-gitea/gitea/pull/32573

Reviewed-on: https://gitea.com/gitea/docs/pulls/102
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Marcell Mars <ki.ber@kom.uni.st>
Co-committed-by: Marcell Mars <ki.ber@kom.uni.st>
2024-11-22 04:07:17 +00:00
wxiaoguang
79767d83a7 Update ALLOWED_TYPES (#96)
Reviewed-on: https://gitea.com/gitea/docs/pulls/96
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2024-11-15 05:53:35 +00:00
Zettat123
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 <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/91
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
2024-11-13 00:26:38 +00:00
talltechy
06c7f7f975 docs: Add ProtonMail SMTP configuration instructions (#93)
#### Summary
This pull request adds detailed instructions for configuring ProtonMail's SMTP server in the `email-setup.md` documentation. The new section provides step-by-step guidance on generating SMTP tokens and configuring the `app.ini` file for ProtonMail.

#### Changes
- Added a new section under the "ProtonMail" heading in `email-setup.md`.
- Included instructions for generating SMTP tokens in ProtonMail settings.
- Provided an example configuration for the `app.ini` file to use ProtonMail's SMTP server.

Reviewed-on: https://gitea.com/gitea/docs/pulls/93
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.com>
Co-authored-by: talltechy <matt@mattwyen.me>
Co-committed-by: talltechy <matt@mattwyen.me>
2024-11-12 19:36:54 +00:00
philipparndt
e8344b03cb Document Reverse Proxy authentication for API (#84)
I figured out that the reverse proxy authentication for the API is supported (implemented with https://github.com/go-gitea/gitea/pull/26703). This will update the documentation to the current state.

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Philipp Arndt <2f.mail@gmx.de>
Reviewed-on: https://gitea.com/gitea/docs/pulls/84
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: philipparndt <philipparndt@noreply.gitea.com>
Co-committed-by: philipparndt <philipparndt@noreply.gitea.com>
2024-11-12 19:35:18 +00:00
wxiaoguang
43da98e72c update BATCH_OPERATION_CONCURRENCY to 8 (#90)
Reviewed-on: https://gitea.com/gitea/docs/pulls/90
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2024-11-06 18:40:50 +00:00
wxiaoguang
ae3a7fade6 Update FAQ (#92)
* add `How to find the config file "app.ini"`
* remove outdated ones

Reviewed-on: https://gitea.com/gitea/docs/pulls/92
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2024-11-06 00:00:49 +00:00
Asadbek Karimov
be4c144777 Update docs/administration/config-cheat-sheet.md 2024-11-05 18:34:05 +00:00
Asad
75c7efc23d docs: Update gitea cron job documentation for repository archive deletion
- Added detailed documentation for `cron.delete_repo_archives` settings.
- Documented configuration options including `ENABLED`, `RUN_AT_START`, `NOTICE_ON_SUCCESS`, and `SCHEDULE`.
- Ensured consistent formatting across cron job documentation.

This update improves clarity on how to configure periodic deletion of repository archives within Gitea.
2024-11-04 20:20:06 -05:00
rremer
82c020a3cb Document [lfs_client].BATCH_OPERATION_CONCURRENCY (#88)
re: https://github.com/go-gitea/gitea/pull/32369
Co-authored-by: Royce Remer <rremer@salesforce.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/88
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: rremer <rremer@noreply.gitea.com>
Co-committed-by: rremer <rremer@noreply.gitea.com>
2024-11-04 17:58:03 +00:00
Royce Remer
26b5b9448f Document configurable LFS BATCH_SIZE and MAX_BATCH_SIZE.
Signed-off-by: Royce Remer <royceremer@gmail.com>
2024-10-30 23:05:58 +00:00
jbalonso
ce0d8b898b Document missing "packages" scope feature for GITEA_TOKEN (#77)
As per https://github.com/go-gitea/gitea/issues/23642#issuecomment-2119876692, this documents a missing feature for `GITEA_TOKEN` authorizing access to the package repository.

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/77
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: jbalonso <jbalonso@noreply.gitea.com>
Co-committed-by: jbalonso <jbalonso@noreply.gitea.com>
2024-10-30 22:27:35 +00:00
Lunny Xiao
05271fd4e6 Update faq for actions to correct wrong documentations. (#85)
- [x] User-level runners are supported from 1.20
- [x] Actions are enabled by default from 1.21

Reviewed-on: https://gitea.com/gitea/docs/pulls/85
2024-10-28 18:04:52 +00:00
thezzisu
d527654df3 Update docs for USER_DISABLED_FEATURES (#76)
Update docs for this PR: https://github.com/go-gitea/gitea/pull/31959

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/76
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: thezzisu <thezzisu@gmail.com>
Co-committed-by: thezzisu <thezzisu@gmail.com>
2024-10-26 03:33:01 +00:00
Lunny Xiao
5bfca46fd6 Merge branch 'main' into lunny/update_agit_forcepush 2024-10-22 06:42:24 +00:00
Zettat123
76cb5ec6ea add DISABLE_ORGANIZATIONS_PAGE and DISABLE_CODE_PAGE 2024-10-18 09:46:41 +08:00
Lunny Xiao
6fc2decd0c update agit forcepush 2024-10-11 00:02:19 -07:00
eliroca
19dc1eccd2 Add force-push usage for agit workflow (#78)
```
git push origin HEAD:refs/for/main -o force-push=true -o topic="agit-workflow-usage" -o title="Add force-push usage for agit workflow"
```

Co-authored-by: Elisei Roca <eroca@suse.de>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/78
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: eliroca <eliroca@noreply.gitea.com>
Co-committed-by: eliroca <eliroca@noreply.gitea.com>
2024-10-10 21:31:09 +00:00
ConcurrentCrab
9cee5acb6b administration: Add docs for server.LFS_ALLOW_PURE_SSH (#49)
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/49
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.com>
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: 6543 <6543@obermui.de>
Co-authored-by: ConcurrentCrab <ishan1939.be21@chitkara.edu.in>
Co-committed-by: ConcurrentCrab <ishan1939.be21@chitkara.edu.in>
2024-09-28 07:33:44 +00: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
wxiaoguang
bbaeadb0c8 Update docs/administration/reverse-proxies.md 2024-09-18 07:09:48 +00:00
Zettat123
a74adaaefd Documentation for migrating from AWS CodeCommit (#65)
Related to https://github.com/go-gitea/gitea/pull/31981

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/65
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
2024-09-11 03:25:40 +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 <xiaolunwen@gmail.com>
Co-authored-by: Jason Song <i@wolfogre.com>
Co-committed-by: Jason Song <i@wolfogre.com>
2024-09-10 02:32:33 +00:00
Lunny Xiao
75bb2f36ff make act runner documentation more easy to use (#64)
Reviewed-on: https://gitea.com/gitea/docs/pulls/64
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-committed-by: Lunny Xiao <xiaolunwen@gmail.com>
2024-09-07 19:40:47 +00:00