Skip to content

Improve docs about register/run as a service #27461

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.

Sign up for GitHub

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 4 commits into from
Oct 9, 2023
Merged

Improve docs about register/run as a service #27461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ca75ae1
improve docs about register/run as a service
lng2020 Oct 5, 2023
99b00ae
align
lng2020 Oct 5, 2023
2b14dd7
fix lin
lng2020 Oct 8, 2023
10f3393
Merge branch 'main' into improve_docs
GiteaBot Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/content/installation/run-as-service-in-ubuntu.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

Expand All @@ -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:

Expand Down
17 changes: 9 additions & 8 deletions docs/content/installation/windows-service.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -14,8 +14,9 @@ menu:
sidebar_position: 50
identifier: "windows-service"
---
# Register as a Windows service

# Prerequisites
## Prerequisites

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

Expand All @@ -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:

Expand All @@ -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 Gitea

To register Gitea as a Windows service, open a command prompt (cmd) as an Administrator,
then run the following command:
Expand All @@ -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
Expand All @@ -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:

Expand All @@ -70,9 +71,9 @@ 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 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
Expand Down