diff options
author | qwerty287 <80460567+qwerty287@users.noreply.github.com> | 2021-11-28 14:28:30 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-28 21:28:30 +0800 |
commit | b1df89095163d8ce3eecfeb855e7f03f17b473c4 (patch) | |
tree | 4f1d80e46f9a433c4b69d615a3c5be3bbfd36823 /docs/content/doc/usage | |
parent | 1fee11d69a437ec7e68b3f6b645827592fe77292 (diff) | |
download | gitea-b1df89095163d8ce3eecfeb855e7f03f17b473c4.tar.gz gitea-b1df89095163d8ce3eecfeb855e7f03f17b473c4.zip |
Docs: replace `gitea` with `Gitea` (#17838)
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Diffstat (limited to 'docs/content/doc/usage')
-rw-r--r-- | docs/content/doc/usage/command-line.en-us.md | 18 | ||||
-rw-r--r-- | docs/content/doc/usage/reverse-proxies.en-us.md | 4 |
2 files changed, 11 insertions, 11 deletions
diff --git a/docs/content/doc/usage/command-line.en-us.md b/docs/content/doc/usage/command-line.en-us.md index 410e9e952c..296f87b51c 100644 --- a/docs/content/doc/usage/command-line.en-us.md +++ b/docs/content/doc/usage/command-line.en-us.md @@ -79,8 +79,8 @@ Admin operations: - `gitea admin user delete --id 1` - `create`: - Options: - - `--name value`: Username. Required. As of gitea 1.9.0, use the `--username` flag instead. - - `--username value`: Username. Required. New in gitea 1.9.0. + - `--name value`: Username. Required. As of Gitea 1.9.0, use the `--username` flag instead. + - `--username value`: Username. Required. New in Gitea 1.9.0. - `--password value`: Password. Required. - `--email value`: Email. Required. - `--admin`: If provided, this makes the user an admin. Optional. @@ -301,7 +301,7 @@ Provides an SSHD AuthorizedKeysCommand. Needs to be configured in the sshd confi ```ini ... # The value of -e and the AuthorizedKeysCommandUser should match the -# username running gitea +# username running Gitea AuthorizedKeysCommandUser git AuthorizedKeysCommand /path/to/gitea keys -e git -u %u -t %t -k %k ``` @@ -311,7 +311,7 @@ provided key. You should also set the value `SSH_CREATE_AUTHORIZED_KEYS_FILE=false` in the `[server]` section of `app.ini`. -NB: opensshd requires the gitea program to be owned by root and not +NB: opensshd requires the Gitea program to be owned by root and not writable by group or others. The program must be specified by an absolute path. NB: Gitea must be running for this command to succeed. @@ -327,13 +327,13 @@ Converts an existing MySQL database from utf8 to utf8mb4. ### doctor -Diagnose the problems of current gitea instance according the given configuration. +Diagnose the problems of current Gitea instance according the given configuration. Currently there are a check list below: - Check if OpenSSH authorized_keys file id correct - When your gitea instance support OpenSSH, your gitea instance binary path will be written to `authorized_keys` - when there is any public key added or changed on your gitea instance. - Sometimes if you moved or renamed your gitea binary when upgrade and you haven't run `Update the '.ssh/authorized_keys' file with Gitea SSH keys. (Not needed for the built-in SSH server.)` on your Admin Panel. Then all pull/push via SSH will not be work. + When your Gitea instance support OpenSSH, your Gitea instance binary path will be written to `authorized_keys` + when there is any public key added or changed on your Gitea instance. + Sometimes if you moved or renamed your Gitea binary when upgrade and you haven't run `Update the '.ssh/authorized_keys' file with Gitea SSH keys. (Not needed for the built-in SSH server.)` on your Admin Panel. Then all pull/push via SSH will not be work. This check will help you to check if it works well. For contributors, if you want to add more checks, you can wrie ad new function like `func(ctx *cli.Context) ([]string, error)` and @@ -367,7 +367,7 @@ with the defaults set appropriately by using: gitea doctor recreate-table user ``` -You can ask gitea to recreate multiple tables using: +You can ask Gitea to recreate multiple tables using: ``` gitea doctor recreate-table table1 table2 ... diff --git a/docs/content/doc/usage/reverse-proxies.en-us.md b/docs/content/doc/usage/reverse-proxies.en-us.md index a22dba2bc4..f0c9d79f8f 100644 --- a/docs/content/doc/usage/reverse-proxies.en-us.md +++ b/docs/content/doc/usage/reverse-proxies.en-us.md @@ -60,7 +60,7 @@ We can tune the performance in splitting requests into categories static and dyn CSS files, JavaScript files, images and web fonts are static content. The front page, a repository view or issue list is dynamic content. -Nginx can serve static resources directly and proxy only the dynamic requests to gitea. +Nginx can serve static resources directly and proxy only the dynamic requests to Gitea. Nginx is optimized for serving static content, while the proxying of large responses might be the opposite of that (see [https://serverfault.com/q/587386](https://serverfault.com/q/587386)). @@ -95,7 +95,7 @@ server { Set `[server] STATIC_URL_PREFIX = http://cdn.example.com/gitea` in your configuration. ```apacheconf -# application server running gitea +# application server running Gitea server { listen 80; server_name git.example.com; |