gogs注册为windows服务

刺骨的言语ヽ痛彻心扉 2022-12-18 07:54 421阅读 0赞

### 文章目录 ###

*  前提
 *   *  前提
     *  方法一：使用内置功能
     *  方法二：使用nssm

# 前提 #

操作版本为:`gogs_0.12.1_windows_amd64`。

## 前提 ##

想要使 Gogs 通过 Windows 服务的方式运行，必须满足以下两个条件：

1.  使用 `minwinsvc` 构建标签获得内置 Windows 服务支持。
2.  不使用 `minwinsvc` 构建标签并通过 [NSSM][] 注册为服务。

在注册成为服务之前，需要确保给予 Gogs 二进制相应目录的读写权限，包括存放仓库的根目录（`[repository] ROOT`）。

修改 `C:\Gogs\custom\conf\app.ini` 文件的相应信息：

RUN_USER = COMPUTERNAME$

通过上面的配置将 Gogs 的运行用户设置为本地系统用户。`COMPUTERNAME` 的值可以通过命令 `echo %COMPUTERNAME%` 获得，如果该命令的返回值为 `USER-PC` 则使用 `RUN_USER = USER-PC$`：

[server]
    DOMAIN = gogs
    PROTOCOL = http
    HTTP_ADDR = 127.0.1.1
    HTTP_PORT = 80
    OFFLINE_MODE = true
    EXTERNAL_URL = http://gogs/

Moves Gogs’ listen port to 80 on the local interface subnet, and tells the Gogs HTTPd that its virtual host is the “gogs” domain. This lets you forgo including a port number when browsing, and prevents collision with other localhost services. The IP address can be anything in the range `127.0.0.2 - 127.254.254.254`, so long as it’s unique to Gogs.

To complete that network route, open Notepad.exe as administrator and include the following in `C:\Windows\System32\drivers\etc\hosts`:

# Gogs local HTTPd
    127.0.1.1        gogs

The hosts file entry will guarantee that all requests to the “gogs” domain are captured by your localhost interface. In a web browser, generally, `gogs/` in the address bar is sufficient to trigger that route.

## 方法一：使用内置功能 ##

打开命令提示符(命令提示符)作为管理员。运行以下命令

sc create gogs start= auto binPath= "\"C:\gogs\gogs.exe\" web --config \"C:\gogs\custom\conf\app.ini\""

确保每个`=`后面有空格。您可以选择添加其他参数以进一步修改服务，也可以在服务管理控制台中手动修改。  
要启动服务，请执行以下命令

C:\> net start gogs

您应该看到以下输出

The gogs service is starting.
    The gogs service was started successfully.

## 方法二：使用nssm ##

得到nssm.exe文件需要您的计算机（32位或64位；它们打包在Iain的zip文件中），并将其放在%PATH%环境变量中（或将添加到）的目录中。以管理员身份打开命令行，然后执行以下命令将Gogs配置为服务

以管理员身份打开命令行，然后执行以下命令将Gogs配置为服务:

C:\>nssm install gogs

“NSSM服务安装程序”将出现。配置如下

Application tab:

*  Path: `C:\gogs\gogs.exe`
 *  Startup directory: `C:\gogs`
 *  Arguments: `web`

![img][]

Details tab:

*  Display name: `Gogs`
 *  Description: `A painless self-hosted Git service.`
 *  Startup type: `Automatic (Delayed Start)`

Note that we’ve chosen [delayed start][], so that the service will not impact the early boot time. Gogs will start two minutes after the non-delayed services.

![img][img 1]

I/O tab:

*  Output (stdout): `C:\gogs\log\gogs-nssm.txt`
 *  Error (stderr): `C:\gogs\log\gogs-nssm.txt`

That will capture all text output that you would normally receive from Gogs on the command line console, and log it to that file instead.

![img][img 2]

File rotation tab:

*  Check: `Rotate files`
 *  Restrict rotation to files bigger than: `1000000 bytes`

![img][img 3]

Environment tab:

*  Environment variables: `PATH=%PATH%;C:\gogs;C:\Program Files (x86)\Git\bin`

That is a guarantee that both `gogs.exe` and `git.exe` will be on the Gogs service’s path variable during runtime.

![img][img 4]

Click “Install service”, and you should be confirmed that it succeeded.

If it failed, refer back to the command line console you started, for the error message. When it succeeds, go to command line and do:

nssm start gogs

You should see:

gogs: START: The operation completed successfully.

Check that this is true by opening `C:\gogs\log\gogs-nssm.txt`. You should see Gogs’ start up procedures, ending with:

timestamp [I] Run Mode: Production
    timestamp [I] Listen: http://127.0.1.1:80

Now point your web browser at `http://gogs/` and log in.

Gogs is running as a service, and will not need to be run manually, unless something goes wrong. NSSM will attempt to restart the service for you, if the Gogs server crashes.

When you need to restart it after `app.ini` changes, go to an administrator command line after the changes, and do:

nssm restart gogs

See the [configuration cheat sheet][] for reference of the `custom\conf\app.ini` settings.

An example of the logging and error handling in action:

[log]
    ROOT_PATH = C:\gogs\log

At the time of writing this line, it will cause the following to print in `C:\gogs\log\gogs-nssm.txt`:

timestamp [T] Custom path: C:/gogs/custom
    timestamp [T] Log path: C:\gogs\log
    timestamp [I] Gogs x.y.z
    timestamp [log.go:294 Error()] [E] Fail to set logger(file): invalid character 'g' in string escape code

This is what was expected in `C:\custom\conf\app.ini`:

ROOT_PATH = C:/gogs/log

And this was the `nssm` interaction while solving it:

C:\>nssm restart gogs
    gogs: STOP: The operation completed successfully.
    gogs: Unexpected status SERVICE_PAUSED in response to START control.
    
    C:\>nssm start gogs
    gogs: START: An instance of the service is already running.
    
    C:\>nssm stop gogs
    gogs: STOP: The operation completed successfully.
    
    C:\>nssm start gogs
    gogs: Unexpected status SERVICE_PAUSED in response to START control.
    
    C:\>nssm restart gogs
    gogs: STOP: The operation completed successfully.
    gogs: START: The operation completed successfully.

[NSSM]: http://nssm.cc/
[img]: /images/20221122/34aee4d0cfd44255b3b6c553fdc01ad8.png
[delayed start]: http://stackoverflow.com/a/11015576
[img 1]: /images/20221122/e46fc1704eba4764a5c248f74b72d5ac.png
[img 2]: /images/20221122/361e1f463fcb4ca8ae8f105fd9051163.png
[img 3]: /images/20221122/14632d1228674d7387c1675b9e466ff6.png
[img 4]: /images/20221122/ae756a1e146e43b1b57ac28c3ab650b9.png
[configuration cheat sheet]: https://gogs.io/docs/advanced/configuration_cheat_sheet.html