mirror of
https://git.zepheris.com/zepheris/LinuxRMM-Script.git
synced 2024-11-09 12:08:21 +00:00
Update README.md
This commit is contained in:
parent
b75b8441b4
commit
942bf1b514
71
README.md
71
README.md
@ -1,2 +1,71 @@
|
||||
# rmmagent-script
|
||||
Script for easy install and update of TacticalRMM agent for linux (Beta currently)
|
||||
Script for one-line installing and update of tacticalRMM agent
|
||||
|
||||
> 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)
|
||||
|
||||
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://raw.githubusercontent.com/ZoLuSs/rmmagent-script/main/rmmagent-linux.sh`
|
||||
|
||||
## Install
|
||||
To install agent launch the script with this arguement:
|
||||
|
||||
```bash
|
||||
./rmmagent-linux-x64.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...
|
||||
|
||||
The argument are:
|
||||
|
||||
2. System type
|
||||
|
||||
Type of system. Can be 'amd64' 'x86' 'arm64' 'armv6'
|
||||
|
||||
3. Mesh agent
|
||||
|
||||
The url givent 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-linux-x64.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-linux-x64.sh update
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user