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
2026-09-20 04:58:52 +00:00 · 2024-06-14 05:53:15 +00:00
parent b4dddf8804
commit 9a8396aa29
219 changed files with 487 additions and 644 deletions
@@ -17,7 +17,7 @@ menu:

 Gitea's executable contains all the resources required to run: templates, images, style-sheets
 and translations. Any of them can be overridden by placing a replacement in a matching path
-inside the `custom` directory (see [Customizing Gitea](administration/customizing-gitea.md)).
+inside the `custom` directory (see [Customizing Gitea](../administration/customizing-gitea.md)).

 To obtain a copy of the embedded resources ready for editing, the `embedded` command from the CLI
 can be used from the OS shell interface.
@@ -83,7 +83,7 @@ The default is the current directory.
 The `--custom` flag tells Gitea to extract the files directly into the `custom` directory.
 For this to work, the command needs to know the location of the `app.ini` configuration
 file (`--config`) and, depending of the configuration, be ran from the directory where
-Gitea normally starts. See [Customizing Gitea](administration/customizing-gitea.md) for details.
+Gitea normally starts. See [Customizing Gitea](../administration/customizing-gitea.md) for details.

 The `--overwrite` flag allows any existing files in the destination directory to be overwritten.

@@ -772,7 +772,7 @@ and
 - `FORCE_TRUST_SERVER_CERT`: **false**: If set to `true`, completely ignores server certificate validation errors. This option is unsafe. Consider adding the certificate to the system trust store instead.
 - `USER`: **_empty_**: Username of mailing user (usually the sender's e-mail address).
 - `PASSWD`: **_empty_**: Password of mailing user.  Use \`your password\` for quoting if you use special characters in the password.
-  - Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or SMTP host is localhost. See [Email Setup](administration/email-setup.md) for more information.
+  - Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or SMTP host is localhost. See [Email Setup](../administration/email-setup.md) for more information.
 - `ENABLE_HELO`: **true**: Enable HELO operation.
 - `HELO_HOSTNAME`: **(retrieved from system)**: HELO hostname.
 - `FROM`: **_empty_**: Mail from address, RFC 5322. This can be just an email address, or the "Name" \<email@example.com\> format.
@@ -82,7 +82,7 @@ directory at the top of this document).
 Every single page of Gitea can be changed. Dynamic content is generated using [go templates](https://golang.org/pkg/html/template/),
 which can be modified by placing replacements below the `$GITEA_CUSTOM/templates` directory.

-To obtain any embedded file (including templates), the [`gitea embedded` tool](administration/cmd-embedded.md) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using).
+To obtain any embedded file (including templates), the [`gitea embedded` tool](../administration/cmd-embedded.md) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using).

 Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
 shouldn't be touched without fully understanding these components.
@@ -54,7 +54,7 @@ Restart Gitea for the configuration changes to take effect.

 To send a test email to validate the settings, go to Gitea > Site Administration > Configuration > SMTP Mailer Configuration.

-For the full list of options check the [Config Cheat Sheet](administration/config-cheat-sheet.md)
+For the full list of options check the [Config Cheat Sheet](../administration/config-cheat-sheet.md)

 Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through:

@@ -22,7 +22,7 @@ it is just a matter of:
 - add some configuration to your `app.ini` file
 - restart your Gitea instance

-This supports rendering of whole files. If you want to render code blocks in markdown you would need to do something with javascript. See some examples on the [Customizing Gitea](administration/customizing-gitea.md) page.
+This supports rendering of whole files. If you want to render code blocks in markdown you would need to do something with javascript. See some examples on the [Customizing Gitea](../administration/customizing-gitea.md) page.

 ## Installing external binaries

@@ -20,7 +20,7 @@ menu:
 Before you enable HTTPS, make sure that you have valid SSL/TLS certificates.
 You could use self-generated certificates for evaluation and testing. Please run `gitea cert --host [HOST]` to generate a self signed certificate.

-If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide](administration/reverse-proxies.md).
+If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide](../administration/reverse-proxies.md).

 To use Gitea's built-in HTTPS support, you must change your `app.ini` file:

@@ -34,7 +34,7 @@ KEY_FILE  = key.pem
 ```

 Note that if your certificate is signed by a third party certificate authority (i.e. not self-signed), then cert.pem should contain the certificate chain. The server certificate must be the first entry in cert.pem, followed by the intermediaries in order (if any). The root certificate does not have to be included because the connecting client must already have it in order to estalbish the trust relationship.
-To learn more about the config values, please checkout the [Config Cheat Sheet](administration/config-cheat-sheet.md#server-server).
+To learn more about the config values, please checkout the [Config Cheat Sheet](../administration/config-cheat-sheet.md#server-server).

 For the `CERT_FILE` or `KEY_FILE` field, the file path is relative to the `GITEA_CUSTOM` environment variable when it is a relative path. It can be an absolute path as well.

@@ -83,11 +83,11 @@ ACME_DIRECTORY=https
 ACME_EMAIL=email@example.com
 ```

-To learn more about the config values, please checkout the [Config Cheat Sheet](administration/config-cheat-sheet.md#server-server).
+To learn more about the config values, please checkout the [Config Cheat Sheet](../administration/config-cheat-sheet.md#server-server).

 ## Using a reverse proxy

-Setup up your reverse proxy as shown in the [reverse proxy guide](administration/reverse-proxies.md).
+Setup up your reverse proxy as shown in the [reverse proxy guide](../administration/reverse-proxies.md).

 After that, enable HTTPS by following one of these guides:

@@ -21,7 +21,7 @@ If you don't want your repository to be visible for search engines read further.
 ## Block search engines indexation using robots.txt

 To make Gitea serve a custom `robots.txt` (default: empty 404) for top level installations,
-create a file called `robots.txt` in the [`custom` folder or `CustomPath`](administration/customizing-gitea.md)
+create a file called `robots.txt` in the [`custom` folder or `CustomPath`](../administration/customizing-gitea.md)

 Examples on how to configure the `robots.txt` can be found at [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt).

@@ -266,7 +266,7 @@ Please note you should use the Swagger 2.0 documentation, not the OpenAPI 3 docu
 When creating new configuration options, it is not enough to add them to the
 `modules/setting` files. You should add information to `custom/conf/app.ini`
 and to the
-[configuration cheat sheet](administration/config-cheat-sheet.md)
+[configuration cheat sheet](../administration/config-cheat-sheet.md)
 found in `docs/content/doc/administer/config-cheat-sheet.en-us.md`

 ### Changing the logo
@@ -88,7 +88,7 @@ https://github.com/loganinak/MigrateGitlabToGogs

 There are a few places that could make this show incorrectly.

-1. If using a reverse proxy, make sure you have followed the correction directions in the [reverse proxy guide](administration/reverse-proxies.md)
+1. If using a reverse proxy, make sure you have followed the correction directions in the [reverse proxy guide](../administration/reverse-proxies.md)
 2. Make sure you have correctly set `ROOT_URL` in the `server` section of your `app.ini`

 If certain clone options aren't showing up (HTTP/S or SSH), the following options can be checked in your `app.ini`
@@ -101,7 +101,7 @@ If certain clone options aren't showing up (HTTP/S or SSH), the following option

 This error occurs when the reverse proxy limits the file upload size.

-See the [reverse proxy guide](administration/reverse-proxies.md) for a solution with nginx.
+See the [reverse proxy guide](../administration/reverse-proxies.md) for a solution with nginx.

 ## Custom Templates not loading or working incorrectly

@@ -114,7 +114,7 @@ The correct path for the template(s) will be relative to the `CustomPath`
    If that doesn't exist, you can try `echo $GITEA_CUSTOM`

 2. If you are still unable to find a path, the default can be [calculated above](#where-does-gitea-store-what-file)
-3. Once you have figured out the correct custom path, you can refer to the [customizing Gitea](administration/customizing-gitea.md) page to add your template to the correct location.
+3. Once you have figured out the correct custom path, you can refer to the [customizing Gitea](../administration/customizing-gitea.md) page to add your template to the correct location.

 ## Does Gitea have a "GitHub/GitLab pages" feature?

@@ -132,7 +132,7 @@ A "login prohibited" user is a user that is not allowed to log in to Gitea anymo

 ## Setting up logging

- [Official Docs](administration/logging-documentation.md)
+- [Official Docs](../administration/logging-documentation.md)

 ## What is Swagger?

@@ -155,7 +155,7 @@ There are multiple things you can combine to prevent spammers.
 1. By whitelisting or blocklisting certain email domains
 2. By only whitelisting certain domains with OpenID (see below)
 3. Setting `ENABLE_CAPTCHA` to `true` in your `app.ini` and properly configuring `RECAPTCHA_SECRET` and `RECAPTCHA_SITEKEY`
-4. Settings `DISABLE_REGISTRATION` to `true` and creating new users via the [CLI](administration/command-line.md), [API](development/api-usage.md), or Gitea's Admin UI
+4. Settings `DISABLE_REGISTRATION` to `true` and creating new users via the [CLI](../administration/command-line.md), [API](development/api-usage.md), or Gitea's Admin UI

 ### Only allow/block certain email domains

@@ -183,7 +183,7 @@ At some point, a customer or third party needs access to a specific repo and onl

 ### Enable Fail2ban

-Use [Fail2Ban](administration/fail2ban-setup.md) to monitor and stop automated login attempts or other malicious behavior based on log patterns
+Use [Fail2Ban](../administration/fail2ban-setup.md) to monitor and stop automated login attempts or other malicious behavior based on log patterns

 ## How to add/use custom themes

@@ -336,24 +336,24 @@ You may want to set this value to `60m` or `120m`.

 ## How can I create users before starting Gitea

-Gitea provides a sub-command `gitea migrate` to initialize the database, after which you can use the [admin CLI commands](administration/command-line.md#admin) to add users like normal.
+Gitea provides a sub-command `gitea migrate` to initialize the database, after which you can use the [admin CLI commands](../administration/command-line.md#admin) to add users like normal.

 ## How can I enable password reset

-There is no setting for password resets. It is enabled when a [mail service](administration/email-setup.md) is configured, and disabled otherwise.
+There is no setting for password resets. It is enabled when a [mail service](../administration/email-setup.md) is configured, and disabled otherwise.

 ## How can a user's password be changed

 - As an **admin**, you can change any user's password (and optionally force them to change it on next login)...
  - By navigating to your `Site Administration -> User Accounts` page and editing a user.
-  - By using the [admin CLI commands](administration/command-line.md#admin).
+  - By using the [admin CLI commands](../administration/command-line.md#admin).

-    Keep in mind most commands will also need a [global flag](administration/command-line.md#global-options) to point the CLI at the correct configuration.
+    Keep in mind most commands will also need a [global flag](../administration/command-line.md#global-options) to point the CLI at the correct configuration.
 - As a **user** you can change it...
  - In your account `Settings -> Account` page (this method **requires** you to know your current password).
  - By using the `Forgot Password` link.

-    If the `Forgot Password/Account Recovery` page is disabled, please contact your administrator to configure a [mail service](administration/email-setup.md).
+    If the `Forgot Password/Account Recovery` page is disabled, please contact your administrator to configure a [mail service](../administration/email-setup.md).

 ## Why is my markdown broken

@@ -425,13 +425,13 @@ You should only set this option once you have completely configured everything.
 Sometimes when there are migrations the old columns and default values may be left
 unchanged in the database schema. This may lead to warning such as:

-```
+```log
 2020/08/02 11:32:29 ...rm/session_schema.go:360:Sync2() [W] Table user Column keep_activity_private db default is , struct default is 0
 ```

 These can safely be ignored, but you are able to stop these warnings by getting Gitea to recreate these tables using:

-```
+```bash
 gitea doctor recreate-table user
 ```

@@ -440,13 +440,13 @@ with the defaults set appropriately.

 You can ask Gitea to recreate multiple tables using:

-```
+```bash
 gitea doctor recreate-table table1 table2 ...
 ```

 And if you would like Gitea to recreate all tables simply call:

-```
+```bash
 gitea doctor recreate-table
 ```

@@ -465,6 +465,6 @@ If you are using Cloudflare, turn off the auto-minify option in the dashboard.
  - You can also check `<ROOT_URL>/admin/config` for the repository root path.
 - Ensure that the user/org exists that you want to adopt repositories for.
 - As an admin, go to `<ROOT_URL>/admin/repos/unadopted` and search.
-  - Users can also be given similar permissions via config [`ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`](administration/config-cheat-sheet.md#repository).
+  - Users can also be given similar permissions via config [`ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`](../administration/config-cheat-sheet.md#repository-repository).
 - If the above steps are done correctly, you should be able to select repositories to adopt.
-  - If no repositories are found, enable [debug logging](administration/config-cheat-sheet.md#repository) to check for any specific errors.
+  - If no repositories are found, enable [debug logging](../administration/config-cheat-sheet.md#repository-repository) to check for any specific errors.
@@ -1,17 +0,0 @@
---
-date: "2019-11-12T16:00:00+02:00"
-title: "Search"
-slug: "search"
-sidebar_position: 1
-toc: false
-draft: false
-sitemap:
-  priority : 1
-layout: "search"
---
-
-This file exists solely to respond to /search URL with the related `search` layout template.
-
-No content shown here is rendered, all content is based in the template layouts/doc/search.html
-
-Setting a very low sitemap priority will tell search engines this is not important content.
@@ -61,7 +61,7 @@ despite warnings like `This key is not certified with a trusted signature!`.
 ## Recommended server configuration

 :::note
-Many of the following directories can be configured using [Environment Variables](administration/environment-variables.md) as well!
+Many of the following directories can be configured using [Environment Variables](../administration/environment-variables.md) as well!
 Of note, configuring `GITEA_WORK_DIR` will tell Gitea where to base its working directory, as well as ease installation.
 :::

@@ -113,7 +113,7 @@ If you don't want the web installer to be able to write to the config file, it i
 * Ensure that the `SECRET_KEY` and `INTERNAL_TOKEN` values are set. (You may want to use the `gitea generate secret` to generate these secret keys.)
 * Ensure that any other secret keys you need are set.

-See the [command line documentation](administration/command-line.md) for information on using `gitea generate secret`.
+See the [command line documentation](../administration/command-line.md) for information on using `gitea generate secret`.

 ### Configure Gitea's working directory

@@ -160,7 +160,7 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini
 You can update to a new version of Gitea by stopping Gitea, replacing the binary at `/usr/local/bin/gitea` and restarting the instance.
 The binary file name should not be changed during the update to avoid problems in existing repositories.

-It is recommended that you make a [backup](administration/backup-and-restore.md) before updating your installation.
+It is recommended that you make a [backup](../administration/backup-and-restore.md) before updating your installation.

 If you have carried out the installation steps as described above, the binary should
 have the generic name `gitea`. Do not change this, i.e. to include the version number.
@@ -28,7 +28,7 @@ Whenever a package gets deleted only the references to the underlaying blobs are
 The blobs get not removed at this moment, so they still require space on the filesystem.
 When a new package gets uploaded the existing blobs may get referenced again.

-These unreferenced blobs get deleted by a [clean up job](administration/config-cheat-sheet.md#cron---cleanup-expired-packages-croncleanup_packages).
+These unreferenced blobs get deleted by a [clean up job](../administration/config-cheat-sheet.md#cron---cleanup-expired-packages-croncleanup_packages).
 The config setting `OLDER_THAN` configures how long unreferenced blobs are kept before they get deleted.

 ## Cleanup Rules
@@ -68,7 +68,7 @@ The patterns are case-insensitive which matches the behaviour of the package reg

 ### How the cleanup rules work

-The cleanup rules are part of the [clean up job](administration/config-cheat-sheet.md#cron---cleanup-expired-packages-croncleanup_packages) and run periodically.
+The cleanup rules are part of the [clean up job](../administration/config-cheat-sheet.md#cron---cleanup-expired-packages-croncleanup_packages) and run periodically.

 The cleanup rule:

@@ -25,7 +25,7 @@ For organizations, you can define organization-wide labels that are shared with

 Labels have a mandatory name, a mandatory color, an optional description, and must either be exclusive or not (see `Scoped Labels` below).

-When you create a repository, you can ensure certain labels exist by using the `Issue Labels` option. This option lists a number of available label sets that are [configured globally on your instance](administration/customizing-gitea.md#labels). Its contained labels will all be created as well while creating the repository.
+When you create a repository, you can ensure certain labels exist by using the `Issue Labels` option. This option lists a number of available label sets that are [configured globally on your instance](../administration/customizing-gitea.md#labels). Its contained labels will all be created as well while creating the repository.

 ## Scoped Labels

@@ -92,7 +92,7 @@ Sometimes a commit or pull request may fix or bring back a problem documented
 in a particular issue. Gitea supports closing and reopening the referenced
 issues by preceding the reference with a particular _keyword_. Common keywords
 include "closes", "fixes", "reopens", etc. This list can be
-[customized](administration/config-cheat-sheet.md) by the
+[customized](../administration/config-cheat-sheet.md) by the
 site administrator.

 Example:
@@ -48,7 +48,7 @@ Push to create is a feature that allows you to push to a repository that does no

 ## Enabling Push To Create

-In the `app.ini` file, set `ENABLE_PUSH_CREATE_USER` to `true` and `ENABLE_PUSH_CREATE_ORG` to `true` if you want to allow users to create repositories in their own user account and in organizations they are a member of respectively. Restart Gitea for the changes to take effect. You can read more about these two options in the [Configuration Cheat Sheet](administration/config-cheat-sheet.md#repository-repository).
+In the `app.ini` file, set `ENABLE_PUSH_CREATE_USER` to `true` and `ENABLE_PUSH_CREATE_ORG` to `true` if you want to allow users to create repositories in their own user account and in organizations they are a member of respectively. Restart Gitea for the changes to take effect. You can read more about these two options in the [Configuration Cheat Sheet](../administration/config-cheat-sheet.md#repository-repository).

 ## Using Push To Create