Add Readme.md

This commit is contained in:
2026-01-24 11:44:18 +01:00
commit 43f62e7ea9

44
Readme.md Normal file
View File

@@ -0,0 +1,44 @@
# n8n Homepage Dashboard Integration
This workflow allows you to monitor your n8n instance directly from your [Homepage](https://gethomepage.dev/) dashboard. It provides a clean, real-time count of your total workflows and executions without the overhead of complex monitoring tools.
## Features
- **Lightweight**: Uses standard n8n nodes and a tiny JS snippet.
- **Fast**: Returns only the necessary integers instead of massive JSON blobs.
- **Native Integration**: Formatted specifically for the Homepage `customapi` widget.
## Setup Instructions
### 1. n8n Import
1. Download the `n8n_dashboard_workflow.json` from this repository.
2. In your n8n instance, click **Workflows** > **Import from File**.
3. Open the **Webhook** node and copy the **Production URL**.
4. **Save** and **Activate** the workflow.
### 2. Homepage Configuration
Add the following to your `services.yaml` file. Replace `<N8N_WEBHOOK_URL>` with the URL you copied in the previous step.
```yaml
- n8n Statistics:
icon: n8n
href: http://your-n8n-instance:5678
widget:
type: customapi
url: <N8N_WEBHOOK_URL>
method: GET
mappings:
- field: data[0].value
label: Workflows
- field: data[1].value
label: Executions
```
## How it Works
The workflow triggers via a Webhook, fetches all workflow and execution metadata via the n8n API, counts the array lengths in a Code node, and returns a structured JSON object.
Self-serving, selfish, and simple—just the way it should be.
```