From 2486810f8e4d18114e7e848fbb5bf9ed8a157a10 Mon Sep 17 00:00:00 2001 From: Naix <20989997+GhostNaix@users.noreply.github.com> Date: Fri, 16 Sep 2022 19:19:40 +1000 Subject: [PATCH] Added NSSM instructions [+] Added NSSM instructions for installing RustDesk as a service. [+] Added benefits comparison. --- content/self-host/windows/_index.en.md | 69 +++++++++++++++++++++++++- 1 file changed, 68 insertions(+), 1 deletion(-) diff --git a/content/self-host/windows/_index.en.md b/content/self-host/windows/_index.en.md index c259282..448e960 100644 --- a/content/self-host/windows/_index.en.md +++ b/content/self-host/windows/_index.en.md @@ -1,8 +1,75 @@ --- -title: Windows & pm2 +title: Windows & pm2 or NSSM weight: 20 --- +## A cross roads +You now either have two choices, you can either use pm2 (easier) or NSSM (a bit harder) to start the rustdesk server +There are some benefits to using NSSM: +- Backwards compatibility with older windows (Windows Server 2008R2/Windows 7 and earlier although untested). +- Ideal for Windows Server +- Auto start on boot without login (The user who created the startup entry does not need to log on for it to start). +- Running both binaies as Services. +- Standalone (no dependency on nodejs) + +While the benefits of pm2 include: +- Good idea if you run the server on the same computer as your main work computer +- You logon regularly to the user that created the rustdesk startup entry +- More user friendly + +## Installing using NSSM + +### Installing NSSM +Please [download](http://nssm.cc/release/nssm-2.24.zip) and extract NSSM select the appropriate +architecture to your windows system (if x86 use the contents of the win32 folder, if x64 use the +contents of win64 folder). It is also best practice to move the binary of NSSM into the +`Program Files\NSSM` (NSSM once started as a service, it cannot be moved from the directory it was placed in. +thus it is best to tuck it away in Program files) directory of your Installation drive (Usually the C drive). +It is also advisable to add the path (such as `C:\Program Files\NSSM`) to the path variable. + + +### Checking if NSSM is installed properly +If you've done everything correctly the folder `C:\Program Files\NSSM` (in this example I use the C: +drive but you can use whatever drive you installed windows to or whatever path you desire) should +only contain the file `nssm.exe`. + +We will be using `C:\Program Files\NSSM` in this example + +Open Command prompt and run `nssm` if you see a help page you are ready to move onto the next step + +### Run hbbr and hbbs +Download the Windows version of [server program](https://github.com/rustdesk/rustdesk-server/releases). +Unzip the program to the `C:\Program Files\RustDesk Server` (or anywhere you desire just make sure it +doesn't change after the service is installed). now get back to Command prompt + +We will be using `C:\Program Files\RustDesk Server` in this example +```cmd +nssm install "RustDesk hbbs service" "C:\Program Files\RustDesk Server\hbbs.exe" -r 0.0.0.0 -k _ +nssm install "RustDesk hbbr Service" "C:\Program Files\RustDesk Server\hbbr.exe" -k _ +``` +**Note:** +- You can change `RustDesk hbbs service` to whatever you desire to name hbbs the service +- You can change `RustDesk hbbr service` to whatever you desire to name hbbr the service +- You can change `C:\Program Files\RustDesk Server\hbbs.exe` to wherever you placed the rustdesk binaries +- You can change `C:\Program Files\RustDesk Server\hbbr.exe` to wherever you placed the rustdesk binaries +- You do not need the `-k _` option which is optional, it's just for better security + +**Command templates:** + +The command template in case you just want to copy and paste and edit. + +```cmd +nssm install +nssm install +``` + +**Done !** + +(The method above has been tested on Windows Server Core 2022 Standard). + +## or + +## Installing using pm2 ### Install NodeJs