From 39c458f32182b2ec4c9421013bef656440dcc699 Mon Sep 17 00:00:00 2001 From: elpatron Date: Sun, 19 Jan 2025 16:06:48 +0100 Subject: [PATCH] Update README.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 44 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 356f59d..b40c821 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Build and install the [Beszel](https://beszel.dev) agent under Microsoft Windows Download and extract [install-beszel-service.zip](https://gitea.elpatron.me/elpatron/Install-Beszel-Agent/releases/download/1.0/install-beszel-service.zip). -Open a `cmd.exe` shell and start the build-script: +Open a `cmd.exe` shell, `cd` into the script directory (where you extracted the archive) and start the build-script: ``` .\build_agent.cmd @@ -30,9 +30,9 @@ The script will install *Git* and *Go* (if not yet installed) with *Winget*, clo ### Installation -Download and extract [install-beszel-service.zip](https://gitea.elpatron.me/elpatron/Install-Beszel-Agent/releases/download/1.0/install-beszel-service.zip) if you haven´t done this in *(1) Building the executable*. +Download and extract [install-beszel-service.zip](https://gitea.elpatron.me/elpatron/Install-Beszel-Agent/releases/download/1.0/install-beszel-service.zip) if you haven´t done this in before. -Open a `cmd.exe` shell with **administrative rights** . +Open a `cmd.exe` shell with **administrative rights** and `cd` into the script directory (where you extracted the archive). If you have built the agent by yourself: Copy your `agent.exe` binary to the directory where you extracted the scripts. Overwrite `agent.exe` from the archive. @@ -52,4 +52,44 @@ The script copies `agent.exe` into the directory `%ProgramFiles%\BeszelAgent` an The provided `agent.exe` was compiled on January, 17th 2025 by me and should be exchanged by a self compiled or official executable, see *(1) Building the executable*. -For more details, see [*Using Beszel to monitor Windows*](https://blog.ktz.me/using-beszel-to-monitor-windows/) by Alex Kretschmar. \ No newline at end of file +For more details, see [*Using Beszel to monitor Windows*](https://blog.ktz.me/using-beszel-to-monitor-windows/) by Alex Kretschmar. + +## (3) Updating the service + +### Prerequisites + +- To update the Beszel agent, it has to be installed using the install script. + +### Updating + +Download and extract [install-beszel-service.zip](https://gitea.elpatron.me/elpatron/Install-Beszel-Agent/releases/download/1.0/install-beszel-service.zip) if you haven´t done this before. + +Open a `cmd.exe` shell with **administrative rights** and `cd` into the script directory (where you extracted the archive). + +Start the update by launching + +``` +.\update_agent.cmd +``` + +The update will make a fresh clone of the Beszel GitHub repository, build the executable, stop the agent service, copy the new `agent.exe` to `%ProgramFiles%\BeszelAgent` and start the service. + +## (4) Uninstall the service + +### Prerequisites + +- To uninstall the Beszel agent, it has to be installed using the install script. + +### Uninstalling + +Download and extract [install-beszel-service.zip](https://gitea.elpatron.me/elpatron/Install-Beszel-Agent/releases/download/1.0/install-beszel-service.zip) if you haven´t done this before. + +Open a `cmd.exe` shell with **administrative rights**. + +Start the update by launching + +``` +.\uninstall_agent.cmd +``` + +The script will stop and remove the Beszel service and delete the installation directory `%ProgramFiles%\BeszelAgent`. \ No newline at end of file