2017-11-26 16:44:32 -05:00
---
date: "2016-12-21T15:00:00-02:00"
title: "Register as a Windows Service"
slug: "windows-service"
2023-04-04 08:47:31 -05:00
weight: 50
2020-12-09 01:47:06 -05:00
toc: false
2017-11-26 16:44:32 -05:00
draft: false
menu:
sidebar:
parent: "installation"
name: "Windows Service"
2023-04-04 08:47:31 -05:00
weight: 50
2017-11-26 16:44:32 -05:00
identifier: "windows-service"
---
2019-01-16 09:43:26 -05:00
# Prerequisites
The following changes are made in C:\gitea\custom\conf\app.ini:
```
RUN_USER = COMPUTERNAME$
```
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
2021-12-23 22:56:57 -05:00
If you use SQLite3, change the `PATH` to include the full path:
2019-01-16 09:43:26 -05:00
```
[database]
PATH = c:/gitea/data/gitea.db
```
2017-11-26 16:44:32 -05:00
# Register as a Windows Service
2018-01-08 17:48:42 -05:00
To register Gitea as a Windows service, open a command prompt (cmd) as an Administrator,
then run the following command:
2017-11-26 16:44:32 -05:00
```
2019-12-13 00:13:38 -05:00
sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \"C:\gitea\custom\conf\app.ini\""
2017-11-26 16:44:32 -05:00
```
2018-01-08 17:48:42 -05:00
Do not forget to replace `C:\gitea` with the correct Gitea directory.
2017-11-26 16:44:32 -05:00
2018-01-08 17:48:42 -05:00
Open "Windows Services", search for the service named "gitea", right-click it and click on
2019-03-09 16:15:45 -05:00
"Run". If everything is OK, Gitea will be reachable on `http://localhost:3000` (or the port
2018-01-08 17:48:42 -05:00
that was configured).
2017-11-26 16:44:32 -05:00
Fix various typos (#21103)
Found via `codespell -q 3 -S
./options/locale,./options/license,./public/vendor,./web_src/fomantic -L
actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon`
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2022-09-07 13:40:36 -05:00
## Adding startup dependencies
2022-08-28 10:28:42 -05:00
Fix various typos (#21103)
Found via `codespell -q 3 -S
./options/locale,./options/license,./public/vendor,./web_src/fomantic -L
actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon`
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2022-09-07 13:40:36 -05:00
To add a startup dependency to the Gitea Windows service (eg Mysql, Mariadb), as an Administrator, then run the following command:
2022-08-28 10:28:42 -05:00
```
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.
2017-11-26 16:44:32 -05:00
## Unregister as a service
2018-01-08 17:48:42 -05:00
To unregister Gitea as a service, open a command prompt (cmd) as an Administrator and run:
2017-11-26 16:44:32 -05:00
```
2019-12-13 00:13:38 -05:00
sc.exe delete gitea
2017-11-26 16:44:32 -05:00
```