mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-10-31 06:21:11 +00:00 
			
		
		
		
	Update docs for docusaurus v3 (#28125)
Updates the docs for usage with docusaurus v3 Signed-off-by: jolheiser <john.olheiser@gmail.com>
This commit is contained in:
		
					parent
					
						
							
								a3348bfc4d
							
						
					
				
			
			
				commit
				
					
						30b46fb6fa
					
				
			
		
					 5 changed files with 10 additions and 10 deletions
				
			
		|  | @ -343,7 +343,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a | |||
| - `SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** or **username, email**: \[off, username, email, anything\]: Specify the principals values that users are allowed to use as principal. When set to `anything` no checks are done on the principal string. When set to `off` authorized principal are not allowed to be set. | ||||
| - `SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**: Gitea will create a authorized_principals file by default when it is not using the internal ssh server and `SSH_AUTHORIZED_PRINCIPALS_ALLOW` is not `off`. | ||||
| - `SSH_AUTHORIZED_PRINCIPALS_BACKUP`: **false/true**: Enable SSH Authorized Principals Backup when rewriting all keys, default is true if `SSH_AUTHORIZED_PRINCIPALS_ALLOW` is not `off`. | ||||
| - `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}**: Set the template for the command to passed on authorized keys. Possible keys are: AppPath, AppWorkPath, CustomConf, CustomPath, Key - where Key is a `models/asymkey.PublicKey` and the others are strings which are shellquoted. | ||||
| - `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **`{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}`**: Set the template for the command to passed on authorized keys. Possible keys are: AppPath, AppWorkPath, CustomConf, CustomPath, Key - where Key is a `models/asymkey.PublicKey` and the others are strings which are shellquoted. | ||||
| - `SSH_SERVER_CIPHERS`: **chacha20-poly1305@openssh.com, aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com, aes256-gcm@openssh.com**: For the built-in SSH server, choose the ciphers to support for SSH connections, for system SSH this setting has no effect. | ||||
| - `SSH_SERVER_KEY_EXCHANGES`: **curve25519-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group14-sha256, diffie-hellman-group14-sha1**: For the built-in SSH server, choose the key exchange algorithms to support for SSH connections, for system SSH this setting has no effect. | ||||
| - `SSH_SERVER_MACS`: **hmac-sha2-256-etm@openssh.com, hmac-sha2-256, hmac-sha1**: For the built-in SSH server, choose the MACs to support for SSH connections, for system SSH this setting has no effect | ||||
|  | @ -1406,7 +1406,7 @@ Please note that using `self` is not recommended for most cases, as it could mak | |||
| Additionally, it requires you to mirror all the actions you need to your Gitea instance, which may not be worth it. | ||||
| Therefore, please use `self` only if you understand what you are doing. | ||||
| 
 | ||||
| In earlier versions (<= 1.19), `DEFAULT_ACTIONS_URL` could be set to any custom URLs like `https://gitea.com` or `http://your-git-server,https://gitea.com`, and the default value was `https://gitea.com`. | ||||
| In earlier versions (`<= 1.19`), `DEFAULT_ACTIONS_URL` could be set to any custom URLs like `https://gitea.com` or `http://your-git-server,https://gitea.com`, and the default value was `https://gitea.com`. | ||||
| However, later updates removed those options, and now the only options are `github` and `self`, with the default value being `github`. | ||||
| However, if you want to use actions from other git server, you can use a complete URL in `uses` field, it's supported by Gitea (but not GitHub). | ||||
| Like `uses: https://gitea.com/actions/checkout@v3` or `uses: http://your-git-server/actions/checkout@v3`. | ||||
|  |  | |||
|  | @ -335,7 +335,7 @@ menu: | |||
| - `SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** 或 **username, email**:\[off, username, email, anything\]:指定允许用户用作 principal 的值。当设置为 `anything` 时,对 principal 字符串不执行任何检查。当设置为 `off` 时,不允许设置授权的 principal。 | ||||
| - `SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**:当 Gitea 不使用内置 SSH 服务器且 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 不为 `off` 时,默认情况下 Gitea 会创建一个 authorized_principals 文件。 | ||||
| - `SSH_AUTHORIZED_PRINCIPALS_BACKUP`: **false/true**:在重写所有密钥时启用 SSH 授权 principal 备份,默认值为 true(如果 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 不为 `off`)。 | ||||
| - `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}**:设置用于传递授权密钥的命令模板。可能的密钥是:AppPath、AppWorkPath、CustomConf、CustomPath、Key,其中 Key 是 `models/asymkey.PublicKey`,其他是 shellquoted 字符串。 | ||||
| - `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **`{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}`**:设置用于传递授权密钥的命令模板。可能的密钥是:AppPath、AppWorkPath、CustomConf、CustomPath、Key,其中 Key 是 `models/asymkey.PublicKey`,其他是 shellquoted 字符串。 | ||||
| - `SSH_SERVER_CIPHERS`: **chacha20-poly1305@openssh.com, aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com, aes256-gcm@openssh.com**:对于内置的 SSH 服务器,选择支持的 SSH 连接的加密方法,对于系统 SSH,此设置无效。 | ||||
| - `SSH_SERVER_KEY_EXCHANGES`: **curve25519-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group14-sha256, diffie-hellman-group14-sha1**:对于内置 SSH 服务器,选择支持的 SSH 连接的密钥交换算法,对于系统 SSH,此设置无效。 | ||||
| - `SSH_SERVER_MACS`: **hmac-sha2-256-etm@openssh.com, hmac-sha2-256, hmac-sha1**:对于内置 SSH 服务器,选择支持的 SSH 连接的 MAC 算法,对于系统 SSH,此设置无效。 | ||||
|  | @ -1343,7 +1343,7 @@ PROXY_HOSTS = *.github.com | |||
| 此外,它要求您将所有所需的操作镜像到您的 Gitea 实例,这可能不值得。 | ||||
| 因此,请仅在您了解自己在做什么的情况下使用 `self`。 | ||||
| 
 | ||||
| 在早期版本(<= 1.19)中,`DEFAULT_ACTIONS_URL` 可以设置为任何自定义 URL,例如 `https://gitea.com` 或 `http://your-git-server,https://gitea.com`,默认值为 `https://gitea.com`。 | ||||
| 在早期版本(`<= 1.19`)中,`DEFAULT_ACTIONS_URL` 可以设置为任何自定义 URL,例如 `https://gitea.com` 或 `http://your-git-server,https://gitea.com`,默认值为 `https://gitea.com`。 | ||||
| 然而,后来的更新删除了这些选项,现在唯一的选项是 `github` 和 `self`,默认值为 `github`。 | ||||
| 但是,如果您想要使用其他 Git 服务器中的操作,您可以在 `uses` 字段中使用完整的 URL,Gitea 支持此功能(GitHub 不支持)。 | ||||
| 例如 `uses: https://gitea.com/actions/checkout@v3` 或 `uses: http://your-git-server/actions/checkout@v3`。 | ||||
|  |  | |||
|  | @ -138,9 +138,9 @@ All Gitea instances have the built-in API and there is no way to disable it comp | |||
| You can, however, disable showing its documentation by setting `ENABLE_SWAGGER` to `false` in the `api` section of your `app.ini`. | ||||
| For more information, refer to Gitea's [API docs](development/api-usage.md). | ||||
| 
 | ||||
| You can see the latest API (for example) on <https://try.gitea.io/api/swagger>. | ||||
| You can see the latest API (for example) on https://try.gitea.io/api/swagger | ||||
| 
 | ||||
| You can also see an example of the `swagger.json` file at <https://try.gitea.io/swagger.v1.json>. | ||||
| You can also see an example of the `swagger.json` file at https://try.gitea.io/swagger.v1.json | ||||
| 
 | ||||
| ## Adjusting your server for public/private use | ||||
| 
 | ||||
|  |  | |||
|  | @ -142,9 +142,9 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 | |||
| 但是,您可以在app.ini的api部分将ENABLE_SWAGGER设置为false,以禁用其文档显示。 | ||||
| 有关更多信息,请参阅Gitea的[API文档](development/api-usage.md)。 | ||||
| 
 | ||||
| 您可以在上查看最新的API(例如)<https://try.gitea.io/api/swagger>。 | ||||
| 您可以在上查看最新的API(例如)https://try.gitea.io/api/swagger | ||||
| 
 | ||||
| 您还可以在上查看`swagger.json`文件的示例 <https://try.gitea.io/swagger.v1.json>。 | ||||
| 您还可以在上查看`swagger.json`文件的示例 https://try.gitea.io/swagger.v1.json | ||||
| 
 | ||||
| ## 调整服务器用于公共/私有使用 | ||||
| 
 | ||||
|  |  | |||
|  | @ -116,8 +116,8 @@ Pre and Post steps don't have their own section in the job log user interface. | |||
| 
 | ||||
| Previously (Pre 1.21.0), `[actions].DEFAULT_ACTIONS_URL` defaulted to `https://gitea.com`. | ||||
| We have since restricted this option to only allow two values (`github` and `self`). | ||||
| When set to `github`, the new default, Gitea will download non-fully-qualified actions from <https://github.com>. | ||||
| For example, if you use `uses: actions/checkout@v3`, it will download the checkout repository from <https://github.com/actions/checkout.git>. | ||||
| When set to `github`, the new default, Gitea will download non-fully-qualified actions from `https://github.com`. | ||||
| For example, if you use `uses: actions/checkout@v3`, it will download the checkout repository from `https://github.com/actions/checkout.git`. | ||||
| 
 | ||||
| If you want to download an action from another git hoster, you can use an absolute URL, e.g. `uses: https://gitea.com/actions/checkout@v3`. | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue