Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cdgco committed Apr 5, 2024
1 parent dce74ae commit 3d4f5ce
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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`.

Expand Down

0 comments on commit 3d4f5ce

Please sign in to comment.