Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (75 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

100 lines (75 loc) · 2.81 KB

Contributing to Scanopy Integrations

We welcome community integrations! This guide explains how to add your integration to the registry.

Integration Types

Type Description How to Contribute
API External integrations that consume the Scanopy API Add a registry entry pointing to your repo
Discovery Built-in daemon capabilities Requires a PR to the main Scanopy repo

Adding an API Integration

1. Create Your Integration Repository

Your repository should include:

Required files:

  • manifest.json - Integration metadata (see schema)
  • README.md - Setup instructions
  • LICENSE - Open source license

Recommended files:

  • Dockerfile - Container build
  • docker-compose.yml - One-command deployment
  • .env.example - Example environment variables

See templates/python-poll/ for a complete example.

2. Create Your manifest.json

{
  "id": "my-integration",
  "name": "My Integration",
  "description": "What it does (max 200 chars)",
  "categories": ["notifications"],
  "version": "1.0.0",
  "author": {
    "name": "Your Name",
    "github": "yourusername"
  },
  "repository": "https://github.com/you/scanopy-my-integration",
  "license": "MIT",
  "scanopy": {
    "api_version": 1
  }
}

3. Open a Pull Request

Add an entry to registry.json:

{
  "id": "my-integration",
  "type": "api",
  "repository": "https://github.com/you/scanopy-my-integration",
  "official": false
}

Important:

  • The id must match your manifest's id
  • Use kebab-case for the id (lowercase letters, numbers, hyphens)
  • Set official to false for community integrations

4. Review Process

The Scanopy team will review your PR and may request changes. Once approved, your integration will appear in the registry.

Adding a Discovery Integration

Discovery integrations require changes to the Scanopy daemon itself.

  1. Open an issue on scanopy/scanopy proposing the discovery method
  2. Discuss the approach with maintainers
  3. Submit a PR with the implementation
  4. Upon merge, the Scanopy team will add the registry entry and manifest here

Categories

Use one or more of these categories in your manifest:

Category Use For
containers Docker, Kubernetes, Podman
virtualization Proxmox, VMware, Hyper-V
cloud AWS, GCP, Azure
networking Network devices, SNMP
asset-management DCIM, CMDB, IPAM (NetBox, etc.)
notifications Slack, Discord, PagerDuty
ticketing Jira, ServiceNow, Linear
monitoring Prometheus, Datadog, Grafana
backup Data export, S3, file sync

Questions?

Open an issue if you have questions about contributing.