diff --git a/README.md b/README.md index 7a8cb5f..3e26ea4 100644 --- a/README.md +++ b/README.md @@ -1,100 +1,55 @@ -# rmmagent-script -Script for one-line installing and update of tacticalRMM agent +Instructions for installing the RMM agent on Mac computers without paying for codesigning. -> Now x64, x86, arm64 and armv6 scripts are available but only x64 and i386 tested on Debian 11 and Debian 10 on baremetal, VM (Proxmox) and VPS(OVH) -> Tested on raspberry 2B+ with armv7l (chose armv6 on install) +
+Compile the agent yourself +
-Script for other platform will be available futher as I adapt script on other platform. -Feel free to adapt script and submit me ! +`brew install golang` -# Usage -Download the script that match your configuration +`git clone https://github.com/amidaware/rmmagent.git` -### Tips +`cd rmmagent` -Download script with this url: `https://raw.githubusercontent.com/netvolt/LinuxRMM-Script/main/rmmagent-linux.sh` +If using Intel Mac: -## Install -To install agent launch the script with this arguement: +`env CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w"` -```bash -./rmmagent-linux.sh install 'System type' 'Mesh agent' 'API URL' 'Client ID' 'Site ID' 'Auth Key' 'Agent Type' -``` -The compiling can be quite long, don't panic and wait few minutes... USE THE 'SINGLE QUOTES' IN ALL FIELDS! +If using silicon Mac -The argument are: +`env CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags "-s -w"` +
-2. System type +**OR** - Type of system. Can be 'amd64' 'x86' 'arm64' 'armv6' +
+Download the agent from here: +
-3. Mesh agent +Intel Mac: - The url given by mesh for installing new agent. - Go to mesh.fqdn.com > Add agent > Installation Executable Linux / BSD / macOS > **Select the good system type** - Copy **ONLY** the URL with the quote. - -4. API URL +https://github.com/kylefmohr/MacOSRMM-Script/releases/download/v2.4.9/rmmagent-amd64-v2.4.9 - Your api URL for agent communication usually https://api.fqdn.com. - -5. Client ID +Silicon Mac: - The ID of the client in wich agent will be added. - Can be view by hovering the name of the client in the dashboard. - -6. Site ID +https://github.com/kylefmohr/MacOSRMM-Script/releases/download/v2.4.9/rmmagent-arm64-v2.4.9 - The ID of the site in wich agent will be added. - Can be view by hovering the name of the site in the dashboard. - -7. Auth Key +
- Authentification key given by dashboard by going to dashboard > Agents > Install agent (Windows) > Select manual and show - Copy **ONLY** the key after *--auth*. - -8. Agent Type +--- - Can be *server* or *workstation* and define the type of agent. - -### Example -```bash -./rmmagent-linux.sh install amd64 "https://mesh.fqdn.com/meshagents?id=XXXXX&installflags=X&meshinstall=X" "https://api.fqdn.com" 3 1 "XXXXX" server -``` +Because we're not paying for codesigning, we'll get a scary warning the first time we run it. To workaround this, before installing the agent, open the file once by itself *while holding down the `Option` key*. Then click "Open" on the scary warning. Once you've done this, you can proceed to the installation. -## Update +## Installation Instructions: -Simply launch the script that match your system with *update* as argument. + - Go to the web portal for your TacticalRMM instance, and click `Agent` > `Install Agent` + - Select all the options you'd like, *but change macOS to Windows*, and select *manual* for installation method. The Arch section can be ignored. + + image -```bash -./rmmagent-linux.sh update -``` + - Then click "Show Manual Instructions", and copy beginning at `-m install` until the end. You should have something like: `-m install --api https://api.yourdomain.com --client-id 1 --site-id 1 --agent-type workstation --auth --rdp --ping --power` + - Open the terminal and run the downloaded agent *as sudo*, pasting the command line options you previously copied after the binary. Your command should look something like: `sudo rmmagent-amd64-v2.4.9 -m install --api https://api.yourdomain.com --client-id 1 --site-id 1 --agent-type workstation --auth --rdp --ping --power` + - If you get an error about how the file isn't executable, you may have to run `chmod +x `, then rerun the above command. -## Uninstall -To uninstall agent launch the script with this arguement: +You should be good to go! -```bash -./rmmagent-linux.sh uninstall 'Mesh FQDN' 'Mesh ID' -``` -Note: Single quotes must be around the Mesh ID for it to uninstall the mesh agent properly -The argument are: - -2. Mesh FQDN - - Example of FQDN: mesh.fqdn.com - -3. Mesh ID - - The ID given by mesh for installing new agent. - Go to mesh.fqdn.com > Add agent > Linux / BSD (Uninstall) > Copy **ONLY** the last value with the single quotes. - You are looking for a 64 charaters long value of random letter case, numbers, and special characters. - -### Example -```bash -./rmmagent-linux.sh uninstall mesh.fqdn.com 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' -``` - -### WARNING -- You should **only** attempt this if the agent removal feaure on TacticalRMM is not working. -- Running uninstall will **not** remove the connections from the TacticalRMM and MeshCentral Dashboard. You will need to manually remove them. It only forcefully removes the agents from your linux box.