Skip to content

Commit 28ead9e

Browse files
authored
Improve docs about register/run as a service (#27461)
As title
1 parent 5283ce9 commit 28ead9e

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

docs/content/installation/run-as-service-in-ubuntu.en-us.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
date: "2017-07-21T12:00:00+02:00"
3-
title: "Run as service in Linux"
3+
title: "Run as a Linux service"
44
slug: "linux-service"
55
sidebar_position: 40
66
toc: false
@@ -15,11 +15,11 @@ menu:
1515
identifier: "linux-service"
1616
---
1717

18-
### Run Gitea as Linux service
18+
# Run as a Linux service
1919

20-
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).
20+
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).
2121

22-
#### Using systemd
22+
## Using systemd
2323

2424
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.
2525

@@ -41,7 +41,7 @@ If you have systemd version 220 or later, you can enable and immediately start G
4141
sudo systemctl enable gitea --now
4242
```
4343

44-
#### Using supervisor
44+
## Using supervisor
4545

4646
Install supervisor by running below command in terminal:
4747

docs/content/installation/windows-service.en-us.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
date: "2016-12-21T15:00:00-02:00"
3-
title: "Register as a Windows Service"
3+
title: "Register as a Windows service"
44
slug: "windows-service"
55
sidebar_position: 50
66
toc: false
@@ -14,8 +14,9 @@ menu:
1414
sidebar_position: 50
1515
identifier: "windows-service"
1616
---
17+
# Register as a Windows service
1718

18-
# Prerequisites
19+
## Prerequisites
1920

2021
The following changes are made in C:\gitea\custom\conf\app.ini:
2122

@@ -27,7 +28,7 @@ Sets Gitea to run as the local system user.
2728

2829
COMPUTERNAME is whatever the response is from `echo %COMPUTERNAME%` on the command line. If the response is `USER-PC` then `RUN_USER = USER-PC$`
2930

30-
## Use absolute paths
31+
### Use absolute paths
3132

3233
If you use SQLite3, change the `PATH` to include the full path:
3334

@@ -36,7 +37,7 @@ If you use SQLite3, change the `PATH` to include the full path:
3637
PATH = c:/gitea/data/gitea.db
3738
```
3839

39-
# Register as a Windows Service
40+
## Register Gitea
4041

4142
To register Gitea as a Windows service, open a command prompt (cmd) as an Administrator,
4243
then run the following command:
@@ -51,7 +52,7 @@ Open "Windows Services", search for the service named "gitea", right-click it an
5152
"Run". If everything is OK, Gitea will be reachable on `http://localhost:3000` (or the port
5253
that was configured).
5354

54-
## Service startup type
55+
### Service startup type
5556

5657
It was observed that on loaded systems during boot Gitea service may fail to start with timeout records in Windows Event Log.
5758
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
6061
sc.exe config gitea start= delayed-auto
6162
```
6263

63-
## Adding startup dependencies
64+
### Adding startup dependencies
6465

6566
To add a startup dependency to the Gitea Windows service (eg Mysql, Mariadb), as an Administrator, then run the following command:
6667

@@ -70,9 +71,9 @@ sc.exe config gitea depend= mariadb
7071

7172
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.
7273

73-
## Unregister as a service
74+
## Unregister Gitea
7475

75-
To unregister Gitea as a service, open a command prompt (cmd) as an Administrator and run:
76+
To unregister Gitea as a Windows service, open a command prompt (cmd) as an Administrator and run:
7677

7778
```
7879
sc.exe delete gitea

0 commit comments

Comments
 (0)