From 5d42bf26abc3abdb8210ba5aeb07ab333454decf Mon Sep 17 00:00:00 2001 From: Jeremy Date: Thu, 7 Jul 2022 10:30:45 +1200 Subject: [PATCH 01/16] Fix README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 172e16cf56328..c2909b157776f 100644 --- a/README.md +++ b/README.md @@ -45,21 +45,21 @@

- View the chinese version of this document + View this document in Chinese

## Purpose The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. -Using Go, this can be done with an independent binary distribution across + +With Go, this can be done platform-independently across **all platforms** which Go supports, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. -Want to try it before doing anything else? -Do it [with the online demo](https://try.gitea.io/)! +You can try it out using [the online demo](https://try.gitea.io/). This project has been [forked](https://blog.gitea.io/2016/12/welcome-to-gitea/) from -[Gogs](https://gogs.io) since 2016.11 but changed a lot. +[Gogs](https://gogs.io) since November of 2016, but a lot has changed. ## Building @@ -78,7 +78,7 @@ The `build` target is split into two sub-targets: When building from the official source tarballs which include pre-built frontend files, the `frontend` target will not be triggered, making it possible to build without Node.js and Internet connectivity. -Parallelism (`make -j `) is not supported. +Parallelism (`make -j`) is not supported. More info: https://docs.gitea.io/en-us/install-from-source/ @@ -114,7 +114,7 @@ For more information and instructions about how to install Gitea, please look at If you have questions that are not covered by the documentation, you can get in contact with us on our [Discord server](https://discord.gg/Gitea) or create a post in the [discourse forum](https://discourse.gitea.io/). We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea). -The hugo-based documentation theme is hosted at [gitea/theme](https://gitea.com/gitea/theme). +The Hugo-based documentation theme is hosted at [gitea/theme](https://gitea.com/gitea/theme). The official Gitea CLI is developed at [gitea/tea](https://gitea.com/gitea/tea). ## Authors From d4375bc4a941412419ff289f90e5cb7ffc3abf48 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Thu, 7 Jul 2022 10:42:58 +1200 Subject: [PATCH 02/16] Fix index.en-us.md --- docs/content/page/index.en-us.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/content/page/index.en-us.md b/docs/content/page/index.en-us.md index c3a43cd029dbf..e824bab638c2f 100644 --- a/docs/content/page/index.en-us.md +++ b/docs/content/page/index.en-us.md @@ -17,9 +17,12 @@ blog post to read about the justification for a fork. ## Purpose The goal of this project is to provide the easiest, fastest, and most painless way of setting -up a self-hosted Git service. With Go, this can be done with an independent binary distribution -across all platforms and architectures that Go supports. This support includes Linux, macOS, and -Windows, on architectures like amd64, i386, ARM, PowerPC, and others. +up a self-hosted Git service. + +With Go, this can be done platform-independently across +**all platforms** which Go supports, including Linux, macOS, and Windows, +on x86, amd64, ARM and PowerPC architectures. +You can try it out using [the online demo](https://try.gitea.io/). ## Features @@ -268,8 +271,8 @@ Windows, on architectures like amd64, i386, ARM, PowerPC, and others. - Gitea should be run with a dedicated non-root system account on UNIX-type systems. - Note: Gitea manages the `~/.ssh/authorized_keys` file. Running Gitea as a regular user could break that user's ability to log in. - [Git](https://git-scm.com/) version 2.0.0 or later is required. - - [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled when Git >= 2.1.2. - - Git commit-graph rendering will be enabled automatically when Git >= 2.18. + - [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled if Git is on version 2.1.2 or over. + - Git commit-graph rendering will be enabled automatically if Git is on version 2.18 or over. ## Browser Support From 353d8ad7b799179369100376106632774e89a4cf Mon Sep 17 00:00:00 2001 From: Jeremy Date: Thu, 7 Jul 2022 11:00:04 +1200 Subject: [PATCH 03/16] Fix from-binary.en-us.md --- .../doc/installation/from-binary.en-us.md | 70 +++++++------------ 1 file changed, 27 insertions(+), 43 deletions(-) diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index d3486d8150996..6c63d2d9c3dd6 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -23,8 +23,7 @@ embedded assets. This can be different for older releases. {{< toc >}} ## Download - -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: ```sh wget -O gitea https://dl.gitea.io/gitea/{{< version >}}/gitea-{{< version >}}-linux-amd64 @@ -44,19 +43,17 @@ Look for the text `Good signature from "Teabot "` 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! 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. ```sh git --version ``` -Create user to run Gitea (ex. `git`) +Create user to run Gitea (e.g. `git`) ```sh adduser \ --system \ @@ -69,7 +66,6 @@ adduser \ ``` ### Create required directory structure - ```sh mkdir -p /var/lib/gitea/{custom,data,log} chown -R git:git /var/lib/gitea/ @@ -79,62 +75,54 @@ 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 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`. ### 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 export GITEA_WORK_DIR=/var/lib/gitea/ ``` -### Copy Gitea binary to global location - -``` +### Copy the Gitea binary to a global location +```sh 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: ### 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" >}}) ### 2. Running from command-line/terminal - -``` +```sh 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. -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. ### 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`. -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. @@ -142,33 +130,29 @@ 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 -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: -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. -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. ### 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, 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 +165,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. From 141c79fb9d3edc57625e1c4eed28bc0c2ebc7252 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Thu, 7 Jul 2022 11:05:26 +1200 Subject: [PATCH 04/16] Fix README.md (again) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c2909b157776f..9ffd7cd13e953 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. -With Go, this can be done platform-independently across +With Go, this can be done across **all platforms** which Go supports, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. You can try it out using [the online demo](https://try.gitea.io/). From 70e684d50000f0c201aa26bee1ba938a6f94e527 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Thu, 7 Jul 2022 11:06:54 +1200 Subject: [PATCH 05/16] Change English README link text in README_ZH.md --- README_ZH.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_ZH.md b/README_ZH.md index 904b3a4fb6373..2be35742672fd 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -45,7 +45,7 @@

- View the english version of this document + View this document in English

## 目标 From 69765e8e823aba98b91e2542d582f0af14e0019c Mon Sep 17 00:00:00 2001 From: Jeremy Date: Thu, 7 Jul 2022 15:25:25 +1200 Subject: [PATCH 06/16] Add suggestion by @Gusted Co-authored-by: Gusted --- docs/content/page/index.en-us.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/page/index.en-us.md b/docs/content/page/index.en-us.md index e824bab638c2f..ee0914f37aa03 100644 --- a/docs/content/page/index.en-us.md +++ b/docs/content/page/index.en-us.md @@ -271,8 +271,8 @@ You can try it out using [the online demo](https://try.gitea.io/). - Gitea should be run with a dedicated non-root system account on UNIX-type systems. - Note: Gitea manages the `~/.ssh/authorized_keys` file. Running Gitea as a regular user could break that user's ability to log in. - [Git](https://git-scm.com/) version 2.0.0 or later is required. - - [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled if Git is on version 2.1.2 or over. - - Git commit-graph rendering will be enabled automatically if Git is on version 2.18 or over. + - [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled if Git is on version 2.1.2 or higher (Git >= 2.1.2). + - Git commit-graph rendering will be enabled automatically if Git is on version 2.18 or over (Git >= 2.18). ## Browser Support From ea7bb7fec1468b3f0ec92736ed2f561e666e5963 Mon Sep 17 00:00:00 2001 From: zeripath Date: Thu, 7 Jul 2022 21:29:26 +0100 Subject: [PATCH 07/16] Update docs/content/doc/installation/from-binary.en-us.md --- docs/content/doc/installation/from-binary.en-us.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index 6c63d2d9c3dd6..f3791867f2079 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -23,6 +23,7 @@ embedded assets. This can be different for older releases. {{< toc >}} ## Download + 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: ```sh From da0b6597b5146b2a3906dc28c6ea12a562893863 Mon Sep 17 00:00:00 2001 From: zeripath Date: Thu, 7 Jul 2022 21:30:17 +0100 Subject: [PATCH 08/16] Update docs/content/doc/installation/from-binary.en-us.md --- docs/content/doc/installation/from-binary.en-us.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index f3791867f2079..cccdf15583cb0 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -67,6 +67,7 @@ adduser \ ``` ### Create required directory structure + ```sh mkdir -p /var/lib/gitea/{custom,data,log} chown -R git:git /var/lib/gitea/ From ca68aa86984793a03d7de51edf02c05cd8618dd7 Mon Sep 17 00:00:00 2001 From: zeripath Date: Thu, 7 Jul 2022 21:35:05 +0100 Subject: [PATCH 09/16] Newlines after headings and before codeblocks --- .../content/doc/installation/from-binary.en-us.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index cccdf15583cb0..de1edb0880682 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -44,10 +44,12 @@ Look for the text `Good signature from "Teabot "` 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! 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. ```sh @@ -55,6 +57,7 @@ git --version ``` Create user to run Gitea (e.g. `git`) + ```sh adduser \ --system \ @@ -78,6 +81,7 @@ chmod 770 /etc/gitea ``` **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 chmod 750 /etc/gitea chmod 640 /etc/gitea/app.ini @@ -87,27 +91,32 @@ If you don't want the web installer to be able to write the config file at all, ### 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. + ```sh export GITEA_WORK_DIR=/var/lib/gitea/ ``` ### Copy the Gitea binary to a global location + ```sh cp gitea /usr/local/bin/gitea ``` ## Running Gitea + After you complete the above steps, you can run Gitea two ways: ### 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" >}}) ### 2. Running from command-line/terminal + ```sh 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. The binary file name should not be changed during the update to avoid problems in existing repositories. @@ -117,9 +126,11 @@ If you have carried out the installation steps as described above, the binary sh have the generic name `gitea`. Do not change this, i.e. to include the version number. ### 1. Restarting Gitea with systemd (recommended) + As we explained before, we recommend to use systemd as the service manager. In this case, `systemctl restart gitea` should be fine. ### 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`. To gracefully stop the Gitea instance, a simple `kill $GITEA_PID` or `killall gitea` is enough. @@ -132,6 +143,7 @@ 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 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 @@ -140,12 +152,14 @@ possible to [install from source]({{< relref "from-source.en-us.md" >}}), withou SQLite support. ### Running Gitea on another port + For errors like `702 runWeb()] [E] Failed to start server: listen tcp 0.0.0.0:3000: 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. It is recommended to switch to the arm6 version, which has been tested and shown to work on Raspberry Pis and similar devices. @@ -154,6 +168,7 @@ It is recommended to switch to the arm6 version, which has been tested and shown please remove after fixing the arm7 bug ---> ### Git error after updating to a new version of Gitea + If during the update, the binary file name has been changed to a new version of Gitea, Git Hooks in existing repositories will not work any more. In that case, a Git error will be displayed when pushing to the repository. From 2f244fd3d9d030f095a6858a140c619555bde12c Mon Sep 17 00:00:00 2001 From: zeripath Date: Thu, 7 Jul 2022 21:50:00 +0100 Subject: [PATCH 10/16] Apply suggestions from code review --- docs/content/doc/installation/from-binary.en-us.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index de1edb0880682..df9fea3b3fd17 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -107,6 +107,7 @@ cp gitea /usr/local/bin/gitea After you complete the above steps, you can run Gitea two ways: ### 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" >}}) ### 2. Running from command-line/terminal From 6dad95fd40fbe29af3b5989d94833fdcef805efe Mon Sep 17 00:00:00 2001 From: Jeremy Date: Fri, 8 Jul 2022 13:57:53 +1200 Subject: [PATCH 11/16] Add suggestion by @zeripath Co-authored-by: zeripath --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ffd7cd13e953..bfbc4f26dee5f 100644 --- a/README.md +++ b/README.md @@ -53,9 +53,9 @@ The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. -With Go, this can be done across -**all platforms** which Go supports, including Linux, macOS, and Windows -on x86, amd64, ARM and PowerPC architectures. +As Gitea is written in Go, it works across **all** the platforms and +architectures that are supported by Go, including Linux, macOS, and +Windows on x86, amd64, ARM and PowerPC architectures. You can try it out using [the online demo](https://try.gitea.io/). This project has been [forked](https://blog.gitea.io/2016/12/welcome-to-gitea/) from From ee5789998973c4604e52119bf9ba17f124a9fcae Mon Sep 17 00:00:00 2001 From: Jeremy Date: Fri, 8 Jul 2022 13:58:07 +1200 Subject: [PATCH 12/16] Add suggestion by @zeripath Co-authored-by: zeripath --- docs/content/doc/installation/from-binary.en-us.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index df9fea3b3fd17..4f344e5acfa10 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -56,7 +56,7 @@ Check that Git is installed on the server. If it is not, install it first. Gitea git --version ``` -Create user to run Gitea (e.g. `git`) +Create a user to run Gitea (e.g. `git`) ```sh adduser \ From 3017aa760659beef00f46c4082ad94694fc8d8d9 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Fri, 8 Jul 2022 13:58:41 +1200 Subject: [PATCH 13/16] Add suggestion by @zeripath Co-authored-by: zeripath --- docs/content/doc/installation/from-binary.en-us.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index 4f344e5acfa10..c598317b6ec09 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -86,7 +86,15 @@ chmod 770 /etc/gitea 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`). 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`. + +If you don't want the web installer to be able to write to the config file, it is possible to make the config file read-only for the Gitea user (owner/group `root:git`, mode `0640`) however you will need to edit your config file manually to: + + * Set `INSTALL_LOCK= true`, + * Ensure all database configuration details are set correctly + * 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]({{< relref "doc/usage/command-line.en-us.md" >}}) for information on using `gitea generate secret`. ### Configure Gitea's working directory From 2927f1254d4ca6a7e7bab27cde4eae4cf017c26a Mon Sep 17 00:00:00 2001 From: Jeremy Date: Sun, 10 Jul 2022 14:59:34 +1200 Subject: [PATCH 14/16] Add suggestion by @delvh Co-authored-by: delvh --- docs/content/page/index.en-us.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/page/index.en-us.md b/docs/content/page/index.en-us.md index ee0914f37aa03..72a2e91fa38b0 100644 --- a/docs/content/page/index.en-us.md +++ b/docs/content/page/index.en-us.md @@ -271,7 +271,7 @@ You can try it out using [the online demo](https://try.gitea.io/). - Gitea should be run with a dedicated non-root system account on UNIX-type systems. - Note: Gitea manages the `~/.ssh/authorized_keys` file. Running Gitea as a regular user could break that user's ability to log in. - [Git](https://git-scm.com/) version 2.0.0 or later is required. - - [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled if Git is on version 2.1.2 or higher (Git >= 2.1.2). + - [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled and if your Git version is >= 2.1.2 - Git commit-graph rendering will be enabled automatically if Git is on version 2.18 or over (Git >= 2.18). ## Browser Support From 492006ca505a3d9befb3c6287c1fd940bbe6a974 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Sun, 10 Jul 2022 14:59:42 +1200 Subject: [PATCH 15/16] Add suggestion by @delvh Co-authored-by: delvh --- docs/content/page/index.en-us.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/page/index.en-us.md b/docs/content/page/index.en-us.md index 72a2e91fa38b0..f9da78df510d2 100644 --- a/docs/content/page/index.en-us.md +++ b/docs/content/page/index.en-us.md @@ -272,7 +272,7 @@ You can try it out using [the online demo](https://try.gitea.io/). - Note: Gitea manages the `~/.ssh/authorized_keys` file. Running Gitea as a regular user could break that user's ability to log in. - [Git](https://git-scm.com/) version 2.0.0 or later is required. - [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled and if your Git version is >= 2.1.2 - - Git commit-graph rendering will be enabled automatically if Git is on version 2.18 or over (Git >= 2.18). + - Git commit-graph rendering will be enabled automatically if your Git version is >= 2.18 ## Browser Support From 01076297dff80bfb0309085d2fa5352599f38fd8 Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Thu, 14 Jul 2022 18:18:29 +0800 Subject: [PATCH 16/16] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bfbc4f26dee5f..4f9ee05fd5b9a 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ The `build` target is split into two sub-targets: When building from the official source tarballs which include pre-built frontend files, the `frontend` target will not be triggered, making it possible to build without Node.js and Internet connectivity. -Parallelism (`make -j`) is not supported. +Parallelism (`make -j `) is not supported. More info: https://docs.gitea.io/en-us/install-from-source/