mattchis/MacRMM-Script
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Read Me

Browse Source
This commit is contained in:
Mattchis 2023-07-27 15:51:09 -06:00
parent ada0180330
commit ff968abdd4
1 changed files with 84 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
README.md
View File

@ -1,3 +1,86 @@
# MacRMM-Script
To help users that want to add Mac Agents to Tactical RMM, without need to pay upfront for code signed agents. If this solution works for you, consider contributing to Tactical RMM project!
To help users that want to add Mac Agents to Tactical RMM, without need to pay upfront for code signed agents. If this solution works for you, consider contributing to Tactical RMM project!
# rmmagent-script
Script for one-line installing and update of tacticalRMM agent
> Now amd64 and arm64 scripts are available but only the amd64 scipt has been tested on macOS 13 (Ventura)
Script for other platform will be available futher as I adapt script on other platform.
Feel free to adapt script and submit me !
# Usage
Download the script that match your configuration
### Tips
Download script with this url: `https://git.mattchis.net/mattchis/MacRMM-Script/raw/branch/main/rmmagent-mac.sh`
## Install
To install agent launch the script with this arguement:
```bash
./rmmagent-mac.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!
The argument are:
2. System type
Type of system. Can be 'amd64' 'arm64'
3. Mesh agent
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
Your api URL for agent communication usually https://api.fqdn.com.
5. Client ID
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
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-mac.sh install amd64 "https://mesh.fqdn.com/meshagents?id=XXXXX&installflags=X&meshinstall=X" "https://api.fqdn.com" 3 1 "XXXXX" server
```
## Update
Simply launch the script that match your system with *update* as argument.
```bash
./rmmagent-mac.sh update
```
## Uninstall
To uninstall agent launch the script with this arguement:
```bash
./rmmagent-mac.sh uninstall
```
### 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.