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

chore: add caution notice

Browse Source
This commit is contained in:
Daan Selen
2026-02-06 17:40:35 +01:00
parent 6374ea50b7
commit 2cfd7ad06e
1 changed files with 2 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -7
View File
@@ -5,8 +5,6 @@
> \[!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).
## What problem does it solve? ## What problem does it solve?
@@ -17,8 +15,6 @@ 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
@@ -68,7 +64,8 @@ Also here, make sure to fill in the `./api.conf` file.
> 📌 Rename `api.conf.template` to `api.conf` and fill in your actual connection details. > 📌 Rename `api.conf.template` to `api.conf` and fill in your actual connection details.
> The URL must start with `wss://<MeshCentral-Host>`. > The URL must start with `wss://<MeshCentral-Host>`.
> [!CAUTION]
> Negative potential consequences of an action.
## 🚀 Running Meshbook ## 🚀 Running Meshbook
@@ -92,8 +89,6 @@ Use `--help` to explore available command-line options:
python3 meshbook.py --help python3 meshbook.py --help
``` ```
## 🛠️ Creating Configurations ## 🛠️ Creating Configurations
Meshbook configurations are written in YAML. Below is an overview of supported fields. Meshbook configurations are written in YAML. Below is an overview of supported fields.