daanselen/meshbook
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

chore: edit readme

Browse Source
This commit is contained in:
DaanSelen
2026-01-29 16:48:44 +01:00
parent 30026a18bd
commit f58e06ddec
2 changed files with 15 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+1
View File
@@ -2,6 +2,7 @@
venv venv
books books
.vscode .vscode
important/
# Byte-compiled / optimized / DLL files # Byte-compiled / optimized / DLL files
__pycache__/ __pycache__/
README.md
+14 -17
View File
@@ -5,7 +5,7 @@
> \[!NOTE] > \[!NOTE]
> 💬 If you experience issues or have suggestions, [submit an issue](https://github.com/DaanSelen/meshbook/issues) — I'll respond ASAP! > 💬 If you experience issues or have suggestions, [submit an issue](https://github.com/DaanSelen/meshbook/issues) — I'll respond ASAP!
---
Meshbook is a tool to **programmatically manage MeshCentral-managed machines**, inspired by tools like [Ansible](https://github.com/ansible/ansible). Meshbook is a tool to **programmatically manage MeshCentral-managed machines**, inspired by tools like [Ansible](https://github.com/ansible/ansible).
@@ -17,14 +17,13 @@ Meshbook is designed to:
* Allow configuration using simple and readable **YAML files** (like Ansible playbooks). * Allow configuration using simple and readable **YAML files** (like Ansible playbooks).
* Simplify the use of **group-based** or **tag-based** device targeting. * Simplify the use of **group-based** or **tag-based** device targeting.
---
## 🏁 Quick Start ## 🏁 Quick Start
### ✅ Prerequisites ### ✅ Prerequisites
* Python 3.7+ * Python 3
* Git
* Access to a MeshCentral instance and credentials with: * Access to a MeshCentral instance and credentials with:
* `Remote Commands` * `Remote Commands`
@@ -33,8 +32,6 @@ Meshbook is designed to:
A service account with access to the relevant device groups is recommended. A service account with access to the relevant device groups is recommended.
---
### 🔧 Installation ### 🔧 Installation
#### Linux #### Linux
@@ -62,7 +59,7 @@ cp .\templates\meshcentral.conf.template .\meshcentral.conf
> 📌 Rename `meshcentral.conf.template` to `meshcentral.conf` and fill in your actual connection details. > 📌 Rename `meshcentral.conf.template` to `meshcentral.conf` and fill in your actual connection details.
> The URL must start with `wss://<MeshCentral-Host>`. > The URL must start with `wss://<MeshCentral-Host>`.
---
## 🚀 Running Meshbook ## 🚀 Running Meshbook
@@ -86,7 +83,7 @@ Use `--help` to explore available command-line options:
python3 meshbook.py --help python3 meshbook.py --help
``` ```
---
## 🛠️ Creating Configurations ## 🛠️ Creating Configurations
@@ -95,7 +92,7 @@ Meshbook configurations are written in YAML. Below is an overview of supported f
### ▶️ Group Targeting (Primary*) ### ▶️ Group Targeting (Primary*)
```yaml ```yaml
---
name: My Configuration name: My Configuration
group: "Dev Machines" group: "Dev Machines"
powershell: true powershell: true
@@ -145,7 +142,7 @@ Each task must include:
* `name`: Description for human readability. * `name`: Description for human readability.
* `command`: The actual shell or PowerShell command. * `command`: The actual shell or PowerShell command.
---
## 🪟 Windows Client Notes ## 🪟 Windows Client Notes
@@ -153,7 +150,7 @@ Each task must include:
* Ensure Windows commands are compatible (use `powershell: true` if needed). * Ensure Windows commands are compatible (use `powershell: true` if needed).
* Examples are available in [`examples/windows`](./examples/windows). * Examples are available in [`examples/windows`](./examples/windows).
---
## 🔎 OS & Tag Filtering ## 🔎 OS & Tag Filtering
@@ -177,12 +174,12 @@ target_tag: "Production"
> ⚠️ Tag values are **case-sensitive**. > ⚠️ Tag values are **case-sensitive**.
---
## 📋 Example Playbook ## 📋 Example Playbook
```yaml ```yaml
---
name: Echo OS Info name: Echo OS Info
group: "Dev" group: "Dev"
target_os: "Linux" target_os: "Linux"
@@ -215,7 +212,7 @@ Sample output:
} }
``` ```
---
## ⚠️ Blocking Commands Warning ## ⚠️ Blocking Commands Warning
@@ -236,7 +233,7 @@ apt upgrade -y
ping 1.1.1.1 -c 1 ping 1.1.1.1 -c 1
``` ```
---
## 🧪 Check Python Environment ## 🧪 Check Python Environment
@@ -249,7 +246,7 @@ pip3 list
The lists should match. If not, make sure the correct environment is activated. The lists should match. If not, make sure the correct environment is activated.
---
## 📂 Project Structure (excerpt) ## 📂 Project Structure (excerpt)
@@ -275,7 +272,7 @@ meshbook/
│ └── config.conf.template │ └── config.conf.template
``` ```
---
## 📄 License ## 📄 License