From 3d4f5ceca2546023fb4c5768272186471d13e882 Mon Sep 17 00:00:00 2001 From: Carter Roeser Date: Thu, 4 Apr 2024 23:54:26 -0700 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4dfbe15..7e2511c 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,13 @@ For standalone installs, you can uninstall the agent by typing: rm -rf /usr/local/lib/rmagent /usr/local/bin/rmagent /usr/local/rmagent ~/.local/share/rmagent ~/.cache/rmagent ``` +For Debian installs, you can uninstall the agent by typing: + +```bash +sudo apt remove rmagent +sudo rm /etc/apt/sources.list.d/rmagent.list +``` + ## MacOS To uninstall the Rack Manage Agent on MacOS, run the following command: @@ -362,8 +369,6 @@ GLOBAL FLAGS DESCRIPTION Installs a plugin into rmagent. - Uses bundled npm executable to install plugins into /Users/roeserc/.local/share/rmagent - Installation of a user-installed plugin will override a core plugin. Use the RMAGENT_NPM_LOG_LEVEL environment variable to set the npm loglevel. @@ -436,8 +441,6 @@ GLOBAL FLAGS DESCRIPTION Installs a plugin into rmagent. - Uses bundled npm executable to install plugins into /Users/roeserc/.local/share/rmagent - Installation of a user-installed plugin will override a core plugin. Use the RMAGENT_NPM_LOG_LEVEL environment variable to set the npm loglevel. @@ -888,6 +891,8 @@ To build installers for MacOS, run the following command: oclif pack macos ``` +This requires that the Apple Developer certificate specified in the `package.json` file is installed on your system. You will be prompted to unlock your keychain to sign the installer. + ### Building Windows Installers To build installers for Windows, run the following command: @@ -904,6 +909,8 @@ To build Debian packages, first, set the `RMAGENT_DEB_KEY` environment variable oclif pack deb ``` +This requires that the GPG key specified in the `RMAGENT_DEB_KEY` environment variable is installed on your system. You will be prompted to enter the passphrase for the key. + Debian packages must be built on a Debian-based system, such as Ubuntu. ## Distributing the Agent @@ -949,7 +956,7 @@ To work around this, you can manually upload the Debian package to Cloudflare R2 aws s3 cp dist/deb s3://rmagent/channels/stable/apt --recursive ``` -In order to handle the cases where Debian attempts to download the package from the `./` directory, a redirect it setup in the Rack Manage Subdomain Router to redirect requests from `https://rmagent-assets.rackmanage.io/channels/stable/apt/./` to `https://rmagent-assets.rackmanage.io/channels/stable/apt/`. +In order to handle the cases where Debian attempts to download the package from the `./` directory, a redirect is setup in the Rack Manage Subdomain Router to redirect requests from `https://rmagent-assets.rackmanage.io/channels/stable/apt/./` to `https://rmagent-assets.rackmanage.io/channels/stable/apt/`. The Debian repository also includes two additional files, `Release.key` and `install.sh` which are used to add the GPG key to the system, and automate the installation of the package. These are manually uploaded to the repository and are not generated by `oclif`.