plugin.json

{
    "id": "com.mattermost.alertmanager",
    "name": "Alertmanager",
    "description": "Bring Prometheus Alertmanager alerts into Mattermost with the runbook attached. Each alert post includes the runbook's first three diagnostic commands inline, pre-filled with the failing host and pod from the alert's labels — copy-paste ready at 3am. Run `/alertmanager help` for the full command list.",
    "homepage_url": "__PLUGIN_REPO_URL__",
    "support_url": "__PLUGIN_REPO_URL__/issues",
    "icon_path": "assets/alertmanager-logo.svg",
    "version": "1.1.0",
    "min_server_version": "10.5.0",
    "server": {
        "executables": {
            "linux-amd64": "server/dist/plugin-linux-amd64",
            "linux-arm64": "server/dist/plugin-linux-arm64"
        }
    },
    "settings_schema": {
        "header": "## Alertmanager Plugin\n\nPrometheus Alertmanager alerts in Mattermost, with the runbook attached.\n\n- 📚 [Documentation](/plugins/com.mattermost.alertmanager/public/help/home.html)\n- 📖 [Runbook library](/plugins/com.mattermost.alertmanager/public/runbooks/home.html)\n- 📈 [Sample Prometheus rules](/plugins/com.mattermost.alertmanager/public/help/prometheus-rules.html)\n- 📊 [Org-wide inventory (sysadmin)](/plugins/com.mattermost.alertmanager/admin/inventory)\n\nRun `/alertmanager help` in any channel for commands. Version `__PLUGIN_VERSION__` — [release notes](__PLUGIN_RELEASE_URL__).",
        "footer": "### Most-used commands\n\n| Command | When |\n|---|---|\n| `/alertmanager add <team> <channel> <am-url>` | First-time setup — creates the 30 canonical receivers in a channel |\n| `/alertmanager rules` | Get the sample Prometheus rules (view or download) |\n| `/alertmanager list` | See receivers bound to this channel |\n\nRun `/alertmanager help` in chat for the full command list.",
        "settings": [
            {
                "key": "AssembledYAMLTTLHours",
                "display_name": "Auto-delete DM'd YAML files after (hours)",
                "type": "number",
                "help_text": "Hours to keep the DM'd receivers.yml/routes.yml (they contain webhook tokens) before auto-deleting; 0 disables auto-delete.",
                "placeholder": "72",
                "default": 72
            },
            {
                "key": "AlertManagerCABundle",
                "display_name": "Alertmanager CA bundle (PEM)",
                "type": "longtext",
                "help_text": "Optional PEM CA bundle so the plugin trusts self-signed or internal Alertmanager certs on its outbound calls; empty uses the system CAs.",
                "placeholder": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
                "default": ""
            },
            {
                "key": "MetricsToken",
                "display_name": "Metrics endpoint bearer token",
                "type": "text",
                "help_text": "Optional bearer token that turns on the Prometheus metrics endpoint at `/plugins/com.mattermost.alertmanager/metrics`; empty disables it (404).",
                "placeholder": "(random 64-character hex string)",
                "default": ""
            },
            {
                "key": "WebhookHostPreset",
                "display_name": "Webhook host — preset",
                "type": "dropdown",
                "help_text": "Quick-fill for how Alertmanager reaches Mattermost to POST alerts. Pick a common setup, or leave 'None' and type a custom value below (a custom value overrides this preset).",
                "default": "",
                "options": [
                    {
                        "display_name": "None — use the custom field below (blank there = Mattermost SiteURL)",
                        "value": ""
                    },
                    {
                        "display_name": "Docker Desktop / Compose — host.docker.internal:8065",
                        "value": "http://host.docker.internal:8065"
                    },
                    {
                        "display_name": "Kubernetes service DNS — namespace 'mattermost' (edit custom field if yours differs)",
                        "value": "http://mattermost.mattermost.svc.cluster.local:8065"
                    }
                ]
            },
            {
                "key": "WebhookHost",
                "display_name": "Webhook host — custom (overrides preset)",
                "type": "text",
                "help_text": "Optional custom host:port for the `api_url` written into alertmanager.yml; overrides the preset above. Use for a non-default K8s namespace or a bare-metal FQDN. Blank = use the preset (or SiteURL if that's None too).",
                "placeholder": "http://mattermost.<your-namespace>.svc.cluster.local:8065",
                "default": ""
            },
            {
                "key": "WebhookRotationDays",
                "display_name": "Webhook rotation reminder period (days)",
                "type": "number",
                "help_text": "Days before the plugin DMs sysadmins to rotate a receiver's webhook (reminder only — no auto-rotation); 0 disables, 90 is a good baseline.",
                "placeholder": "0",
                "default": 0
            }
        ]
    }
}