-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #268 from silversword411/main
v0.19 additions
- Loading branch information
Showing
30 changed files
with
691 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "name": "Run MkDocs", | ||
| "type": "python", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/env/Scripts/mkdocs", | ||
| "args": [ | ||
| "serve" | ||
| ], | ||
| "preLaunchTask": "Run MkDocs" | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| { | ||
| "version": "2.0.0", | ||
| "tasks": [ | ||
| { | ||
| "label": "Activate Python Environment", | ||
| "type": "shell", | ||
| "command": "python -m venv env; .\\env\\Scripts\\activate", | ||
| "problemMatcher": [], | ||
| "group": { | ||
| "kind": "build", | ||
| "isDefault": true | ||
| } | ||
| }, | ||
| { | ||
| "label": "Install Requirements", | ||
| "type": "shell", | ||
| "command": "python -m pip install --upgrade pip; pip install --upgrade setuptools wheel; pip install -r requirements.txt", | ||
| "problemMatcher": [], | ||
| "group": { | ||
| "kind": "build", | ||
| "isDefault": true | ||
| } | ||
| }, | ||
| { | ||
| "label": "Run MkDocs", | ||
| "type": "shell", | ||
| "command": "Start-Process http://localhost:8005; mkdocs serve", | ||
| "problemMatcher": [], | ||
| "group": { | ||
| "kind": "build", | ||
| "isDefault": true | ||
| }, | ||
| "dependsOn": [ | ||
| "Activate Python Environment", | ||
| "Install Requirements" | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| ### Zammad Setup | ||
|
|
||
| 1. **Install Zammad:** | ||
| Follow the installation instructions provided in the [Zammad documentation](https://docs.zammad.org/en/latest/). | ||
|
|
||
| 2. **Generate API Token:** | ||
| - Click on your User Initials in Zammad. | ||
| - Navigate to Profile > Token Access. | ||
| - Click "Create". | ||
| - Name the Token "Tactical RMM" and select "Ticket Agent". | ||
| - Click "Create" to generate the token. | ||
|
|
||
| 3. **Add Customers and Emails:** | ||
| Ensure each customer in Zammad has a corresponding email associated. | ||
|
|
||
| --- | ||
|
|
||
| ### Tactical RMM Setup | ||
|
|
||
| 1. **Add Custom Field in Sites:** | ||
| - Add a custom field under Sites called `Zammad-Email` | ||
| - Populate this field with the corresponding email addresses from Zammad to match up with customers. | ||
|
|
||
| 2. **Add Webhook:** | ||
|
|
||
| - **URL Pattern:** `https://your_zammad_domain.com/api/v1/tickets` | ||
| - **Method:** POST | ||
|
|
||
| 3. **Request Headers:** | ||
| ```json | ||
| { | ||
| "Content-Type": "application/json", | ||
| "Authorization": "Bearer your_generated_token_here" | ||
| } | ||
| ``` | ||
|
|
||
| Replace your_generated_token_here with the actual API token generated from Zammad. | ||
|
|
||
| 4. **Request Body:** | ||
| ```json | ||
| { | ||
| "title": "{{ alert.severity }} on {{ agent.hostname }}", | ||
| "group": "Users", | ||
| "customer": "{{ client.Zammad-Email }}", | ||
| "article": { | ||
| "subject": "{{ alert.severity }} on {{ agent.hostname }}", | ||
| "body": "Client: {{agent.site.client.name}}, Site: {{agent.site.name}}: {{ alert.message }} at {{ alert.alert_time }}", | ||
| "type": "note", | ||
| "internal": false | ||
| } | ||
| } | ||
| ``` | ||
| - `{{ alert.severity }}`, `{{ agent.hostname }}`, `{{ alert.message }}`, and `{{ alert.alert_time }}` are placeholders that will be replaced with actual data from Tactical RMM alerts. | ||
| - `{{ client.Zammad-Email }}` refers to the custom field you added under Sites where you store the corresponding Zammad email for each customer. | ||
|
|
||
| 5. **Add Webhook to Alert Policy**: | ||
|
|
||
| - Assign the webhook to the appropriate Alert Policy that is assigned to customers in Tactical RMM. | ||
|
|
||
| ### Notes: | ||
|
|
||
| - Ensure that the API token in the Authorization header (Bearer your_generated_token_here) has the necessary permissions (e.g., ticket.agent) to create tickets in Zammad. | ||
| - Adjust the title, group, customer, article fields in the request body as per your specific requirements and Zammad's API capabilities. | ||
| - Test the integration thoroughly to ensure that alerts from Tactical RMM are correctly creating tickets in Zammad with the expected data. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.