diff options
author | John Olheiser <john.olheiser@gmail.com> | 2023-07-25 23:53:13 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-26 04:53:13 +0000 |
commit | bd4c7ce578956d9839309b16753bd5505b63b2e3 (patch) | |
tree | 1d3074ef542cee11707bc4985ce54dc40facb9b6 /docs/content/installation/windows-service.en-us.md | |
parent | 5dc37ef97a30628027a723ee944225a33a6511f8 (diff) | |
download | gitea-bd4c7ce578956d9839309b16753bd5505b63b2e3.tar.gz gitea-bd4c7ce578956d9839309b16753bd5505b63b2e3.zip |
Docusaurus-ify (#26051)
This PR cleans up the docs in a way to make them simpler to ingest by
our [docs repo](https://gitea.com/gitea/gitea-docusaurus).
1. It includes all of the sed invocations our ingestion did, removing
the need to do it at build time.
2. It replaces the shortcode variable replacement method with
`@variable@` style, simply for easier sed invocations when required.
3. It removes unused files and moves the docs up a level as cleanup.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Diffstat (limited to 'docs/content/installation/windows-service.en-us.md')
-rw-r--r-- | docs/content/installation/windows-service.en-us.md | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/content/installation/windows-service.en-us.md b/docs/content/installation/windows-service.en-us.md new file mode 100644 index 0000000000..201681bc03 --- /dev/null +++ b/docs/content/installation/windows-service.en-us.md @@ -0,0 +1,70 @@ +--- +date: "2016-12-21T15:00:00-02:00" +title: "Register as a Windows Service" +slug: "windows-service" +sidebar_position: 50 +toc: false +draft: false +aliases: + - /en-us/windows-service +menu: + sidebar: + parent: "installation" + name: "Windows Service" + sidebar_position: 50 + identifier: "windows-service" +--- + +# 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 + +If you use SQLite3, change the `PATH` to include the full path: + +``` +[database] +PATH = c:/gitea/data/gitea.db +``` + +# 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: + +``` +sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \"C:\gitea\custom\conf\app.ini\"" +``` + +Do not forget to replace `C:\gitea` with the correct Gitea directory. + +Open "Windows Services", search for the service named "gitea", right-click it and click on +"Run". If everything is OK, Gitea will be reachable on `http://localhost:3000` (or the port +that was configured). + +## Adding startup dependencies + +To add a startup dependency to the Gitea Windows service (eg Mysql, Mariadb), as an Administrator, then run the following command: + +``` +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 + +To unregister Gitea as a service, open a command prompt (cmd) as an Administrator and run: + +``` +sc.exe delete gitea +``` |