-
-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Fix English mistakes in some Markdown documents #20274
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 10 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
5d42bf2
Fix README.md
dbb7135
Merge branch 'go-gitea:main' into main
d4375bc
Fix index.en-us.md
353d8ad
Fix from-binary.en-us.md
141c79f
Fix README.md (again)
70e684d
Change English README link text in README_ZH.md
69765e8
Add suggestion by @Gusted
99b5185
Merge branch 'go-gitea:main' into main
ea7bb7f
Update docs/content/doc/installation/from-binary.en-us.md
zeripath da0b659
Update docs/content/doc/installation/from-binary.en-us.md
zeripath ca68aa8
Newlines after headings and before codeblocks
zeripath 2f244fd
Apply suggestions from code review
zeripath 6dad95f
Add suggestion by @zeripath
ee57899
Add suggestion by @zeripath
3017aa7
Add suggestion by @zeripath
4cafb41
Merge branch 'main' into main
2927f12
Add suggestion by @delvh
492006c
Add suggestion by @delvh
0107629
Update README.md
wxiaoguang 3aa34e7
Merge branch 'main' into main
wxiaoguang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,7 +24,7 @@ embedded assets. This can be different for older releases. | |
|
||
## Download | ||
|
||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Choose the file matching the destination platform from the [downloads page](https://dl.gitea.io/gitea/), copy the URL and replace the URL within the commands below: | ||
Choose the file matching your platform from the [downloads page](https://dl.gitea.io/gitea/), copy the URL and replace the URL within the commands below: | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```sh | ||
wget -O gitea https://dl.gitea.io/gitea/{{< version >}}/gitea-{{< version >}}-linux-amd64 | ||
|
@@ -44,19 +44,17 @@ Look for the text `Good signature from "Teabot <[email protected]>"` to assert a g | |
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]({{< relref "doc/advanced/environment-variables.en-us.md" >}}) as well! | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Of note, configuring `GITEA_WORK_DIR` will tell Gitea where to base its working directory, as well as ease installation. | ||
|
||
### Prepare environment | ||
|
||
Check that Git is installed on the server. If it is not, install it first. Gitea requires Git version >= 2.0. | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```sh | ||
git --version | ||
``` | ||
|
||
Create user to run Gitea (ex. `git`) | ||
Create user to run Gitea (e.g. `git`) | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
jtbx marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```sh | ||
adduser \ | ||
--system \ | ||
|
@@ -79,96 +77,84 @@ chown root:git /etc/gitea | |
chmod 770 /etc/gitea | ||
``` | ||
|
||
**NOTE:** `/etc/gitea` is temporary set with write rights for user `git` so that Web installer could write configuration file. After installation is done, it is recommended to set rights to read-only using: | ||
``` | ||
**NOTE:** `/etc/gitea` is temporarily set with write permissions for user `git` so that the web installer can write the configuration file. After the installation is finished, it is recommended to set permissions to read-only using: | ||
```sh | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
chmod 750 /etc/gitea | ||
chmod 640 /etc/gitea/app.ini | ||
``` | ||
If you don't want the web installer to be able to write the config file at all, it is also possible to make the config file read-only for the Gitea user (owner/group `root:git`, mode `0640`), and set `INSTALL_LOCK = true`. In that case all database configuration details must be set beforehand in the config file, as well as the `SECRET_KEY` and `INTERNAL_TOKEN` values. See the [command line documentation]({{< relref "doc/usage/command-line.en-us.md" >}}) for information on using `gitea generate secret INTERNAL_TOKEN`. | ||
If you don't want the web installer to be able to write the config file at all, it is also possible to make the config file read-only for the Gitea user (owner/group `root:git`, mode `0640`). Also, make sure `INSTALL_LOCK` is set to `true`. In that case, all database configuration details must be set beforehand in the config file, as well as the `SECRET_KEY` and `INTERNAL_TOKEN` values. See the [command line documentation]({{< relref "doc/usage/command-line.en-us.md" >}}) for information on using `gitea generate secret INTERNAL_TOKEN`. | ||
jtbx marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Configure Gitea's working directory | ||
|
||
**NOTE:** If you plan on running Gitea as a Linux service, you can skip this step as the service file allows you to set `WorkingDirectory`. Otherwise, consider setting this environment variable (semi-)permanently so that Gitea consistently uses the correct working directory. | ||
``` | ||
**NOTE:** If you plan on running Gitea as a Linux service, you can skip this step, as the service file allows you to set `WorkingDirectory`. Otherwise, consider setting this environment variable (semi-)permanently so that Gitea consistently uses the correct working directory. | ||
```sh | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
export GITEA_WORK_DIR=/var/lib/gitea/ | ||
``` | ||
|
||
### Copy Gitea binary to global location | ||
|
||
``` | ||
### Copy the Gitea binary to a global location | ||
```sh | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
cp gitea /usr/local/bin/gitea | ||
``` | ||
|
||
## Running Gitea | ||
|
||
After the above steps, two options to run Gitea are: | ||
After you complete the above steps, you can run Gitea two ways: | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 1. Creating a service file to start Gitea automatically (recommended) | ||
|
||
See how to create [Linux service]({{< relref "run-as-service-in-ubuntu.en-us.md" >}}) | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 2. Running from command-line/terminal | ||
|
||
``` | ||
```sh | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini | ||
``` | ||
|
||
## Updating to a new version | ||
|
||
You can update to a new version of Gitea by stopping Gitea, replacing the binary at `/usr/local/bin/gitea` and restarting the instance. | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
The binary file name should not be changed during the update to avoid problems | ||
in existing repositories. | ||
The binary file name should not be changed during the update to avoid problems in existing repositories. | ||
|
||
It is recommended you do a [backup]({{< relref "doc/usage/backup-and-restore.en-us.md" >}}) before updating your installation. | ||
It is recommended that you make a [backup]({{< relref "doc/usage/backup-and-restore.en-us.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. | ||
|
||
### 1. Restarting Gitea with systemd (recommended) | ||
|
||
As explained before, we recommend to use systemd as service manager. In this case ```systemctl restart gitea``` should be enough. | ||
As we explained before, we recommend to use systemd as the service manager. In this case, `systemctl restart gitea` should be fine. | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 2. Restarting Gitea without systemd | ||
To restart your Gitea instance, we recommend to use SIGHUP signal. If you know your Gitea PID, use `kill -1 $GITEA_PID`, otherwise you can use `killall -1 gitea`. | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
To restart your Gitea instance, we recommend to use SIGHUP signal. If you know your Gitea PID use ```kill -1 $GITEA_PID``` otherwise you can use ```killall -1 gitea``` or ```pkill -1 gitea``` | ||
To gracefully stop the Gitea instance, a simple `kill $GITEA_PID` or `killall gitea` is enough. | ||
|
||
To gracefully stop the Gitea instance, a simple ```kill $GITEA_PID``` or ```killall gitea``` is enough. | ||
|
||
**NOTE:** We don't recommend to use SIGKILL signal (know also as `-9`), you may be forcefully stopping some of Gitea internal tasks and it will not gracefully stop (tasks in queues, indexers processes, etc.) | ||
**NOTE:** We don't recommend to use the SIGKILL signal (`-9`); you may be forcefully stopping some of Gitea's internal tasks, and it will not gracefully stop (tasks in queues, indexers, etc.) | ||
|
||
See below for troubleshooting instructions to repair broken repositories after | ||
an update of your Gitea version. | ||
|
||
## Troubleshooting | ||
|
||
### Old glibc versions | ||
|
||
Older Linux distributions (such as Debian 7 and CentOS 6) may not be able to load the | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Gitea binary, usually producing an error such as ```./gitea: /lib/x86_64-linux-gnu/libc.so.6: | ||
version `GLIBC\_2.14' not found (required by ./gitea)```. This is due to the integrated | ||
Gitea binary, usually producing an error such as `./gitea: /lib/x86_64-linux-gnu/libc.so.6: | ||
version 'GLIBC\_2.14' not found (required by ./gitea)`. This is due to the integrated | ||
SQLite support in the binaries provided by dl.gitea.io. In this situation, it is usually | ||
possible to [install from source]({{< relref "from-source.en-us.md" >}}) without SQLite | ||
support. | ||
possible to [install from source]({{< relref "from-source.en-us.md" >}}), without including | ||
SQLite support. | ||
|
||
### Running Gitea on another port | ||
|
||
For errors like `702 runWeb()] [E] Failed to start server: listen tcp 0.0.0.0:3000: | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
bind: address already in use` Gitea needs to be started on another free port. This | ||
bind: address already in use`, Gitea needs to be started on another free port. This | ||
is possible using `./gitea web -p $PORT`. It's possible another instance of Gitea | ||
is already running. | ||
|
||
### Running Gitea on Raspbian | ||
As of v1.8, there is a problem with the arm7 version of Gitea, and it doesn't run on Raspberry Pis and similar devices. | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
As of v1.8, there is a problem with the arm7 version of Gitea and it doesn't run on Raspberry Pi and similar devices. | ||
|
||
It is therefore recommended to switch to the arm6 version which has been tested and shown to work on Raspberry Pi and similar devices. | ||
It is recommended to switch to the arm6 version, which has been tested and shown to work on Raspberry Pis and similar devices. | ||
|
||
<!--- | ||
please remove after fixing the arm7 bug | ||
---> | ||
### Git error after updating to a new version of Gitea | ||
|
||
If the binary file name has been changed during the update to a new version of Gitea, | ||
If during the update, the binary file name has been changed to a new version of Gitea, | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Git Hooks in existing repositories will not work any more. In that case, a Git | ||
error will be displayed when pushing to the repository. | ||
|
||
|
@@ -181,9 +167,9 @@ binary. | |
|
||
To solve this, go to the admin options and run the task `Resynchronize pre-receive, | ||
update and post-receive hooks of all repositories` to update all hooks to contain | ||
the new binary path. Please note that this overwrite all Git Hooks including ones | ||
the new binary path. Please note that this overwrites all Git Hooks, including ones | ||
with customizations made. | ||
|
||
If you aren't using the built-in to Gitea SSH server you will also need to re-write | ||
If you aren't using the Gitea built-in SSH server, you will also need to re-write | ||
the authorized key file by running the `Update the '.ssh/authorized_keys' file with | ||
Gitea SSH keys.` task in the admin options. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.