Skip to content

Commit 87aa1c3

Browse files
committed
Fix errors in Windows installation guide
1 parent 39276f8 commit 87aa1c3

File tree

4 files changed

+38
-22
lines changed

4 files changed

+38
-22
lines changed

.github/workflows/skyeye.yaml

+6-4
Original file line numberDiff line numberDiff line change
@@ -156,13 +156,15 @@ jobs:
156156
mkdir -p dist/skyeye-windows-amd64/docs/
157157
cp skyeye.exe dist/skyeye-windows-amd64/skyeye.exe
158158
cp skyeye-scaler.exe dist/skyeye-windows-amd64/skyeye-scaler.exe
159-
curl -fsL https://github.com/winsw/winsw/releases/download/v2.12.0/WinSW-x64.exe -o dist/skyeye-windows-amd64/winsw.exe
159+
curl -fsL https://github.com/winsw/winsw/releases/download/v2.12.0/WinSW-x64.exe -o winsw.exe
160160
cp README.md dist/skyeye-windows-amd64/README.md
161161
cp LICENSE dist/skyeye-windows-amd64/LICENSE
162162
cp config.yaml dist/skyeye-windows-amd64/config.yaml
163163
cp docs/*.md dist/skyeye-windows-amd64/docs/
164-
cp init/winsw/skyeye-service.yaml dist/skyeye-windows-amd64/skyeye-service.yaml
165-
cp init/winsw/skyeye-scaler-service.yaml dist/skyeye-windows-amd64/skyeye-scaler-service.yaml
164+
cp winsw.exe dist/skyeye-service.exe
165+
cp init/winsw/skyeye-service.yml dist/skyeye-windows-amd64/skyeye-service.yml
166+
cp winsw.exe dist/skyeye-scaler-service.exe
167+
cp init/winsw/skyeye-scaler-service.yml dist/skyeye-windows-amd64/skyeye-scaler-service.yml
166168
cd dist
167169
zip -r skyeye-windows-amd64.zip skyeye-windows-amd64
168170
- name: Upload artifact
@@ -242,4 +244,4 @@ jobs:
242244
registry-password: ${{ secrets.GITHUB_TOKEN }}
243245
image-name: ${{ github.repository }}-scaler
244246
target: skyeye-scaler
245-
skyeye-version: ${{ env.GITHUB_REF_NAME }}
247+
skyeye-version: ${{ env.GITHUB_REF_NAME }}

docs/ADMIN.md

+32-18
Original file line numberDiff line numberDiff line change
@@ -152,26 +152,26 @@ The body of the POST request is a JSON object with the following fields:
152152

153153
By implementing a small webservice or serverless function that creates or destroys a SkyEye instance on demand, the cost of running SkyEye can be significantly reduced. This is particularly useful for servers that are only active for a few hours a week, such as a private squadron server.
154154

155-
An example WinSW service definition is provided in the Windows release archive. You can edit this example file to include your webhook URL and the frequencies you want to monitor, then install and run it it using the included WinSW executable:
155+
An example WinSW service definition is provided in the Windows release archive. You can edit this example file to include your webhook URL and the frequencies you want to monitor, then install and run it it using the included `skyeye-scaler-service.exe` executable:
156156

157157
```batch
158158
:: Install SkyEye Scaler
159-
./winsw.exe install skyeye-service.yaml
159+
./skyeye-scaler-service.exe install skyeye-scaler-service.yml
160160
161161
:: Start SkyEye Scaler
162-
./winsw.exe start skyeye-service.yaml
162+
./skyeye-scaler-service.exe start skyeye-scaler-service.yml
163163
164164
:: Check if SkyEye Scaler is running
165-
./winsw.exe status skyeye-service.yaml
165+
./skyeye-scaler-service.exe status skyeye-scaler-service.yml
166166
167167
:: Stop SkyEye Scaler
168-
./winsw.exe stop skyeye-service.yaml
168+
./skyeye-scaler-service.exe stop skyeye-scaler-service.yml
169169
170170
:: Restart SkyEye Scaler
171-
./winsw.exe restart skyeye-service.yaml
171+
./skyeye-scaler-service.exe restart skyeye-scaler-service.yml
172172
173173
:: Uninstall SkyEye Scaler
174-
./winsw.exe uninstall skyeye-service.yaml
174+
./skyeye-scaler-service.exe uninstall skyeye-scaler-service.yml
175175
```
176176

177177
The scaler is also available as a container image at `ghcr.io/dharmab/skyeye-scaler`. A Linux binary is also provided in the Linux release archive, although without a service definition.
@@ -311,32 +311,46 @@ journalctl -u skyeye > skyeye.log
311311

312312
Download the SkyEye release ZIP from the [releases page](https://github.com/dharmab/skyeye/releases) and extract it.
313313

314-
Edit `config.yaml` to configure SkyEye as desired. Note that any provided value of `whisper-model` here is ignored because it is overridden in `skyeye-service.yaml`. If you wish to change the whisper.cpp model, edit `skyeye-service.yaml`.
314+
Edit `config.yaml` to configure SkyEye as desired. Note that any provided value of `whisper-model` here is ignored because it is overridden in `skyeye-service.yml`. If you wish to change the whisper.cpp model, edit `skyeye-service.yml`.
315315

316-
If you want SkyEye to automatically start on boot, edit `skyeye-service.yaml` and change `startmode` to "Automatic".
316+
If you want SkyEye to automatically start on boot, edit `skyeye-service.yml` and change `startmode` to "Automatic".
317317

318-
Use the bundled `winsw.exe` to install and start SkyEye:
318+
Use the bundled `skyeye-service.exe` to install and start SkyEye:
319319

320320
```batch
321321
:: Install SkyEye
322-
./winsw.exe install skyeye-service.yaml
322+
./skyeye-service.exe install skyeye-service.yml
323323
324324
:: Start SkyEye
325-
./winsw.exe start skyeye-service.yaml
325+
./skyeye-service.exe start skyeye-service.yml
326326
327327
:: Check if SkyEye is running
328-
./winsw.exe status skyeye-service.yaml
328+
./skyeye-service.exe status skyeye-service.yml
329329
330330
:: Stop SkyEye
331-
./WinSW-x6t4.exe stop skyeye-service.yaml
331+
./skyeye-service-x6t4.exe stop skyeye-service.yml
332332
333333
:: Restart SkyEye
334-
./winsw.exe restart skyeye-service.yaml
334+
./skyeye-service.exe restart skyeye-service.yml
335335
336336
:: Uninstall SkyEye
337-
./winsw.exe uninstall skyeye-service.yaml
337+
./skyeye-service.exe uninstall skyeye-service.yml
338338
```
339339

340-
Refer to the [WinSW documentation](https://github.com/winsw/winsw/tree/v2) for more information.
340+
Refer to the [WinSW documentation](https://github.com/winsw/winsw/tree/v2.12.0) for more information (`skyeye-service.exe` is a renamed `winsw.exe`).
341341

342-
Logs will be saved in a `skyeye.log` file in the same directory as `skyeye-service.yaml`
342+
Logs will be saved in a `skyeye.log` file in the same directory as `skyeye-service.yml`
343+
344+
If you want to change the version of SkyEye in the future:
345+
346+
```batch
347+
:: Stop and Uninstall SkyEye
348+
./skyeye-service.exe stop skyeye-service.yml
349+
./skyeye-service.exe uninstall skyeye-service.yml
350+
351+
:: Download a newer version of SkyEye and replace both skyeye.exe and skyeye-service.yml
352+
353+
:: Install and Start the new version of SkyEye
354+
./skyeye-service.exe install skyeye-service.yml
355+
./skyeye-service.exe start skyeye-service.yml
356+
```
File renamed without changes.

0 commit comments

Comments
 (0)