From ca75ae1659b310ceea4d4a3cdfba530f9550df02 Mon Sep 17 00:00:00 2001 From: lng2020 Date: Thu, 5 Oct 2023 21:55:36 +0800 Subject: [PATCH 1/3] improve docs about register/run as a service --- .../run-as-service-in-ubuntu.en-us.md | 10 +++++----- .../content/installation/windows-service.en-us.md | 15 ++++++++------- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/content/installation/run-as-service-in-ubuntu.en-us.md b/docs/content/installation/run-as-service-in-ubuntu.en-us.md index ab862b373f336..4e169d6bcc032 100644 --- a/docs/content/installation/run-as-service-in-ubuntu.en-us.md +++ b/docs/content/installation/run-as-service-in-ubuntu.en-us.md @@ -1,6 +1,6 @@ --- date: "2017-07-21T12:00:00+02:00" -title: "Run as service in Linux" +title: "Run as a Linux service" slug: "linux-service" sidebar_position: 40 toc: false @@ -15,11 +15,11 @@ menu: identifier: "linux-service" --- -### Run Gitea as Linux service +# Run as a Linux service -You can run Gitea as service, using either systemd or supervisor. The steps below tested on Ubuntu 16.04, but those should work on any Linux distributions (with little modification). +You can run Gitea as a Linux service, using either systemd or supervisor. The steps below tested on Ubuntu 16.04, but those should work on any Linux distributions (with little modification). -#### Using systemd +## Using systemd Copy the sample [gitea.service](https://github.com/go-gitea/gitea/blob/main/contrib/systemd/gitea.service) to `/etc/systemd/system/gitea.service`, then edit the file with your favorite editor. @@ -41,7 +41,7 @@ If you have systemd version 220 or later, you can enable and immediately start G sudo systemctl enable gitea --now ``` -#### Using supervisor +## Using supervisor Install supervisor by running below command in terminal: diff --git a/docs/content/installation/windows-service.en-us.md b/docs/content/installation/windows-service.en-us.md index 90332b7c692da..9094f7f00ace2 100644 --- a/docs/content/installation/windows-service.en-us.md +++ b/docs/content/installation/windows-service.en-us.md @@ -1,6 +1,6 @@ --- date: "2016-12-21T15:00:00-02:00" -title: "Register as a Windows Service" +title: "Register as a Windows service" slug: "windows-service" sidebar_position: 50 toc: false @@ -15,7 +15,8 @@ menu: identifier: "windows-service" --- -# Prerequisites +# Register as a Windows service +## Prerequisites The following changes are made in C:\gitea\custom\conf\app.ini: @@ -27,7 +28,7 @@ Sets Gitea to run as the local system user. COMPUTERNAME is whatever the response is from `echo %COMPUTERNAME%` on the command line. If the response is `USER-PC` then `RUN_USER = USER-PC$` -## Use absolute paths +### Use absolute paths If you use SQLite3, change the `PATH` to include the full path: @@ -36,7 +37,7 @@ If you use SQLite3, change the `PATH` to include the full path: PATH = c:/gitea/data/gitea.db ``` -# Register as a Windows Service +## Register as a Windows service To register Gitea as a Windows service, open a command prompt (cmd) as an Administrator, then run the following command: @@ -51,7 +52,7 @@ Open "Windows Services", search for the service named "gitea", right-click it an "Run". If everything is OK, Gitea will be reachable on `http://localhost:3000` (or the port that was configured). -## Service startup type +### Service startup type It was observed that on loaded systems during boot Gitea service may fail to start with timeout records in Windows Event Log. In that case change startup type to `Automatic-Delayed`. This can be done during service creation, or by running config command @@ -60,7 +61,7 @@ In that case change startup type to `Automatic-Delayed`. This can be done during sc.exe config gitea start= delayed-auto ``` -## Adding startup dependencies +### Adding startup dependencies To add a startup dependency to the Gitea Windows service (eg Mysql, Mariadb), as an Administrator, then run the following command: @@ -72,7 +73,7 @@ This will ensure that when the Windows machine restarts, the automatic starting ## Unregister as a service -To unregister Gitea as a service, open a command prompt (cmd) as an Administrator and run: +To unregister Gitea as a Windows service, open a command prompt (cmd) as an Administrator and run: ``` sc.exe delete gitea From 99b00ae96922865fd5f699761e23b6ad5e3484a3 Mon Sep 17 00:00:00 2001 From: lng2020 Date: Thu, 5 Oct 2023 21:59:00 +0800 Subject: [PATCH 2/3] align --- docs/content/installation/windows-service.en-us.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/content/installation/windows-service.en-us.md b/docs/content/installation/windows-service.en-us.md index 9094f7f00ace2..3dbf50ac92f7b 100644 --- a/docs/content/installation/windows-service.en-us.md +++ b/docs/content/installation/windows-service.en-us.md @@ -16,6 +16,7 @@ menu: --- # Register as a Windows service + ## Prerequisites The following changes are made in C:\gitea\custom\conf\app.ini: From 2b14dd79fa1ca11a8e2d3d9794aee4aeb2841f16 Mon Sep 17 00:00:00 2001 From: lng2020 Date: Sun, 8 Oct 2023 10:10:33 +0800 Subject: [PATCH 3/3] fix lin --- docs/content/installation/windows-service.en-us.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/content/installation/windows-service.en-us.md b/docs/content/installation/windows-service.en-us.md index 3dbf50ac92f7b..6c7d3725491af 100644 --- a/docs/content/installation/windows-service.en-us.md +++ b/docs/content/installation/windows-service.en-us.md @@ -14,7 +14,6 @@ menu: sidebar_position: 50 identifier: "windows-service" --- - # Register as a Windows service ## Prerequisites @@ -38,7 +37,7 @@ If you use SQLite3, change the `PATH` to include the full path: PATH = c:/gitea/data/gitea.db ``` -## Register as a Windows service +## Register Gitea To register Gitea as a Windows service, open a command prompt (cmd) as an Administrator, then run the following command: @@ -72,7 +71,7 @@ sc.exe config gitea depend= mariadb This will ensure that when the Windows machine restarts, the automatic starting of Gitea is postponed until the database is ready and thus mitigate failed startups. -## Unregister as a service +## Unregister Gitea To unregister Gitea as a Windows service, open a command prompt (cmd) as an Administrator and run: