You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
and is synced regularly to Crowdin. Once a translation has reached
112
112
A SATISFACTORY PERCENTAGE it will be synced back into this repo and
@@ -157,7 +157,7 @@ import (
157
157
158
158
## Design guideline
159
159
160
-
To maintain understandable code and avoid circular dependencies it is important to have a good structure of the code. The gitea code is divided into the following parts:
160
+
To maintain understandable code and avoid circular dependencies it is important to have a good structure of the code. The Gitea code is divided into the following parts:
161
161
162
162
-**integration:** Integrations tests
163
163
-**models:** Contains the data structures used by xorm to construct database tables. It also contains supporting functions to query and update the database. Dependencies to other code in Gitea should be avoided although some modules might be needed (for example for logging).
@@ -223,7 +223,7 @@ Additionally you could add a line at the end of your commit message.
Gitea has the `master` branch as a tip branch and has version branches
329
+
Gitea has the `main` branch as a tip branch and has version branches
330
330
such as `release/v0.9`. `release/v0.9` is a release branch and we will
331
331
tag `v0.9.0` for binary download. If `v0.9.0` has bugs, we will accept
332
332
pull requests on the `release/v0.9` branch and publish a `v0.9.1` tag,
333
-
after bringing the bug fix also to the master branch.
333
+
after bringing the bug fix also to the main branch.
334
334
335
-
Since the `master` branch is a tip version, if you wish to use Gitea
335
+
Since the `main` branch is a tip version, if you wish to use Gitea
336
336
in production, please download the latest release tag version. All the
337
337
branches will be protected via GitHub, all the PRs to every branch must
338
338
be reviewed by two maintainers and must pass the automatic tests.
339
339
340
340
## Releasing Gitea
341
341
342
342
* Let $vmaj, $vmin and $vpat be Major, Minor and Patch version numbers, $vpat should be rc1, rc2, 0, 1, ...... $vmaj.$vmin will be kept the same as milestones on github or gitea in future.
343
-
* Before releasing, confirm all the version's milestone issues or PRs has been resolved. Then discuss the release on discord channel #maintainers and get agreed with almost all the owners and mergers. Or you can declare the version and if nobody against in about serval hours.
344
-
* If this is a big version first you have to create PR for changelog on branch `master` with PRs with label `changelog` and after it has been merged do following steps:
343
+
* Before releasing, confirm all the version's milestone issues or PRs has been resolved. Then discuss the release on Discord channel #maintainers and get agreed with almost all the owners and mergers. Or you can declare the version and if nobody against in about serval hours.
344
+
* If this is a big version first you have to create PR for changelog on branch `main` with PRs with label `changelog` and after it has been merged do following steps:
345
345
* Create `-dev` tag as `git tag -s -F release.notes v$vmaj.$vmin.0-dev` and push the tag as `git push origin v$vmaj.$vmin.0-dev`.
346
346
* When CI has finished building tag then you have to create a new branch named `release/v$vmaj.$vmin`
347
347
* If it is bugfix version create PR for changelog on branch `release/v$vmaj.$vmin` and wait till it is reviewed and merged.
348
348
* Add a tag as `git tag -s -F release.notes v$vmaj.$vmin.$`, release.notes file could be a temporary file to only include the changelog this version which you added to `CHANGELOG.md`.
349
-
* And then push the tag as `git push origin v$vmaj.$vmin.$`. Drone CI will automatically created a release and upload all the compiled binary. (But currently it didn't add the release notes automatically. Maybe we should fix that.)
350
-
* If needed send PR for changelog on branch `master`.
349
+
* And then push the tag as `git push origin v$vmaj.$vmin.$`. Drone CI will automatically create a release and upload all the compiled binary. (But currently it doesn't add the release notes automatically. Maybe we should fix that.)
350
+
* If needed send PR for changelog on branch `main`.
351
351
* Send PR to [blog repository](https://gitea.com/gitea/blog) announcing the release.
Now you need to edit the page to meet your requirements. In particular you must change the email addresses, web addresses and references to "Your Gitea Instance" to match your situation.
-`LFS_CONTENT_PATH`: **%(APP_DATA_PATH)/lfs**: Default LFS content path. (if it is on local storage.) **DEPRECATED** use settings in `[lfs]`.
307
307
-`LFS_JWT_SECRET`: **\<empty\>**: LFS authentication secret, change this a unique string.
308
308
-`LFS_HTTP_AUTH_EXPIRY`: **20m**: LFS authentication validity period in time.Duration, pushes taking longer than this may fail.
@@ -378,7 +378,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
378
378
-`require`: Enable TLS without any verifications.
379
379
-`verify-ca`: Enable TLS with verification of the database server certificate against its root certificate.
380
380
-`verify-full`: Enable TLS and verify the database server name matches the given certificate in either the `Common Name` or `Subject Alternative Name` fields.
381
-
-`SQLITE_TIMEOUT`: **500**: Query timeout for sqlite3 only.
381
+
-`SQLITE_TIMEOUT`: **500**: Query timeout for SQLite3 only.
382
382
-`ITERATE_BUFFER_SIZE`: **50**: Internal buffer size for iterating.
383
383
-`CHARSET`: **utf8mb4**: For MySQL only, either "utf8" or "utf8mb4". NOTICE: for "utf8mb4" you must use MySQL InnoDB > 5.6. Gitea is unable to check this.
384
384
-`PATH`: **data/gitea.db**: For SQLite3 only, the database file path.
@@ -490,8 +490,8 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
490
490
-`REVERSE_PROXY_LIMIT`: **1**: Interpret X-Forwarded-For header or the X-Real-IP header and set this as the remote IP for the request.
491
491
Number of trusted proxy count. Set to zero to not use these headers.
492
492
-`REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: List of IP addresses and networks separated by comma of trusted proxy servers. Use `*` to trust all.
493
-
-`DISABLE_GIT_HOOKS`: **true**: Set to `false` to enable users with git hook privilege to create custom git hooks.
494
-
WARNING: Custom git hooks can be used to perform arbitrary code execution on the host operating system.
493
+
-`DISABLE_GIT_HOOKS`: **true**: Set to `false` to enable users with Git Hook privilege to create custom Git Hooks.
494
+
WARNING: Custom Git Hooks can be used to perform arbitrary code execution on the host operating system.
495
495
This enables the users to access and modify this config file and the Gitea database and interrupt the Gitea service.
496
496
By modifying the Gitea database, users can gain Gitea administrator privileges.
497
497
It also enables them to access other resources available to the user on the operating system that is running the
@@ -595,7 +595,7 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
595
595
-`DEFAULT_ORG_MEMBER_VISIBLE`: **false** True will make the membership of the users visible when added to the organisation.
596
596
-`ALLOW_ONLY_INTERNAL_REGISTRATION`: **false** Set to true to force registration only via Gitea.
597
597
-`ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false** Set to true to force registration only using third-party services.
598
-
-`NO_REPLY_ADDRESS`: **noreply.DOMAIN** Value for the domain part of the user's email address in the git log if user has set KeepEmailPrivate to true. DOMAIN resolves to the value in server.DOMAIN.
598
+
-`NO_REPLY_ADDRESS`: **noreply.DOMAIN** Value for the domain part of the user's email address in the Git log if user has set KeepEmailPrivate to true. DOMAIN resolves to the value in server.DOMAIN.
599
599
The user's email will be replaced with a concatenation of the user name in lower case, "@" and NO_REPLY_ADDRESS.
600
600
-`USER_DELETE_WITH_COMMENTS_MAX_TIME`: **0** Minimum amount of time a user must exist before comments are kept when the user is deleted.
601
601
-`VALID_SITE_URL_SCHEMES`: **http, https**: Valid site url schemes for user profiles
@@ -658,7 +658,7 @@ Define allowed algorithms and their minimum key length (use -1 to disable a type
-**sendmail** Use the operating system's `sendmail` command instead of SMTP.
661
-
This is common on linux systems.
661
+
This is common on Linux systems.
662
662
-**dummy** Send email messages to the log as a testing phase.
663
663
- Note that enabling sendmail will ignore all other `mailer` settings except `ENABLED`,
664
664
`FROM`, `SUBJECT_PREFIX` and `SENDMAIL_PATH`.
@@ -918,15 +918,15 @@ NB: You must have `DISABLE_ROUTER_LOG` set to `false` for this option to take ef
918
918
919
919
## Git (`git`)
920
920
921
-
-`PATH`: **""**: The path of git executable. If empty, Gitea searches through the PATH environment.
921
+
-`PATH`: **""**: The path of Git executable. If empty, Gitea searches through the PATH environment.
922
922
-`DISABLE_DIFF_HIGHLIGHT`: **false**: Disables highlight of added and removed changes.
923
923
-`MAX_GIT_DIFF_LINES`: **1000**: Max number of lines allowed of a single file in diff view.
924
924
-`MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: Max character count per line highlighted in diff view.
925
925
-`MAX_GIT_DIFF_FILES`: **100**: Max number of files shown in diff view.
926
926
-`COMMITS_RANGE_SIZE`: **50**: Set the default commits range size
927
927
-`BRANCHES_RANGE_SIZE`: **20**: Set the default branches range size
928
928
-`GC_ARGS`: **\<empty\>**: Arguments for command `git gc`, e.g. `--aggressive --auto`. See more on http://git-scm.com/docs/git-gc/
929
-
-`ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: If use git wire protocol version 2 when git version >= 2.18, default is true, set to false when you always want git wire protocol version 1
929
+
-`ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: If use Git wire protocol version 2 when Git version >= 2.18, default is true, set to false when you always want Git wire protocol version 1
930
930
-`PULL_REQUEST_PUSH_MESSAGE`: **true**: Respond to pushes to a non-default branch with a URL for creating a Pull Request (if the repository has them enabled)
931
931
-`VERBOSE_PUSH`: **true**: Print status information about pushes as they are being processed.
932
932
-`VERBOSE_PUSH_DELAY`: **5s**: Only print verbose information if push takes longer than this delay.
@@ -952,7 +952,7 @@ NB: You must have `DISABLE_ROUTER_LOG` set to `false` for this option to take ef
952
952
-`ENABLE_SWAGGER`: **true**: Enables /api/swagger, /api/v1/swagger etc. endpoints. True or false; default is true.
953
953
-`MAX_RESPONSE_ITEMS`: **50**: Max number of items in a page.
954
954
-`DEFAULT_PAGING_NUM`: **30**: Default paging number of API.
955
-
-`DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Default and maximum number of items per page for git trees API.
955
+
-`DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Default and maximum number of items per page for Git trees API.
956
956
-`DEFAULT_MAX_BLOB_SIZE`: **10485760**: Default max size of a blob that can be return by the blobs API.
Copy file name to clipboardExpand all lines: docs/content/doc/advanced/customizing-gitea.en-us.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -287,7 +287,7 @@ To add a custom license, add a file with the license text to `$GITEA_CUSTOM/opti
287
287
288
288
### Locales
289
289
290
-
Locales are managed via our [crowdin](https://crowdin.com/project/gitea).
290
+
Locales are managed via our [Crowdin](https://crowdin.com/project/gitea).
291
291
You can override a locale by placing an altered locale file in `$GITEA_CUSTOM/options/locale`.
292
292
Gitea's default locale files can be found in the [`options/locale`](https://github.com/go-gitea/gitea/tree/main/options/locale) source folder and these should be used as examples for your changes.
Copy file name to clipboardExpand all lines: docs/content/doc/advanced/protected-tags.en-us.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ menu:
15
15
16
16
# Protected tags
17
17
18
-
Protected tags allow control over who has permission to create or update git tags. Each rule allows you to match either an individual tag name, or use an appropriate pattern to control multiple tags at once.
18
+
Protected tags allow control over who has permission to create or update Git tags. Each rule allows you to match either an individual tag name, or use an appropriate pattern to control multiple tags at once.
Copy file name to clipboardExpand all lines: docs/content/doc/developers/guidelines-backend.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ So it's very important to manage these packages. Please take the below guideline
32
32
To maintain understandable code and avoid circular dependencies it is important to have a good code structure. The Gitea backend is divided into the following parts:
33
33
34
34
-`build`: Scripts to help build Gitea.
35
-
-`cmd`: All Gitea actual sub commands includes web, doctor, serv, hooks, admin and etc. `web` will start the web service. `serv` and `hooks` will be invoked by git or openSSH. Other sub commands could help to maintain Gitea.
35
+
-`cmd`: All Gitea actual sub commands includes web, doctor, serv, hooks, admin and etc. `web` will start the web service. `serv` and `hooks` will be invoked by Git or OpenSSH. Other sub commands could help to maintain Gitea.
36
36
-`integrations`: Integration tests
37
37
-`models`: Contains the data structures used by xorm to construct database tables. It also contains functions to query and update the database. Dependencies to other Gitea code should be avoided. You can make exceptions in cases such as logging.
38
38
-`models/db`: Basic database operations. All other `models/xxx` packages should depend on this package. The `GetEngine` function should only be invoked from `models/`.
0 commit comments