# Planekeeper Docs

> Monitor software versions across your stack. Planekeeper tracks releases, gathers version data, and alerts on drift.

This file is an LLM-friendly index of the site, generated by Hugo.
Each link points at a clean Markdown rendering of the page (suffix
`/index.md`) — token-optimized for LLM ingestion.

## Getting Started

> Get started with Planekeeper. Install the agent, set up scrape jobs, configure rules, and receive alerts when your stack lags behind upstream releases.

- [Account setup](https://docs.planekeeper.com/getting-started/account-setup/index.md): Register for Planekeeper, get approved for the alpha, create your organization, and generate API keys.
- [Quickstart](https://docs.planekeeper.com/getting-started/quickstart/index.md): End-to-end walkthrough to monitor a Helm chart version with Planekeeper in under 10 minutes.
- [What is Planekeeper?](https://docs.planekeeper.com/getting-started/overview/index.md): What Planekeeper does, who it's for, and how it catches forgotten software and outdated software across your infrastructure.

## Feature Guides

> Detailed feature guides for Planekeeper — gather jobs, scrape jobs, agents, rules, alerts, and notification channels.

- [Agents](https://docs.planekeeper.com/guides/agents/index.md): Deploy and configure the Planekeeper client agent to execute gather and scrape tasks at remote sites.
- [Alert Configurations](https://docs.planekeeper.com/guides/alert-configs/index.md): Connect scrape jobs, gather jobs, and rules with alert configurations to start detecting version lag.
- [Alerts](https://docs.planekeeper.com/guides/alerts/index.md): Understand the alert lifecycle, manage severity levels, and acknowledge or resolve version lag alerts.
- [Gather jobs](https://docs.planekeeper.com/guides/gather-jobs/index.md): Set up gather jobs to fetch upstream releases from GitHub, Helm repositories, and OCI container registries.
- [Helm Sync jobs](https://docs.planekeeper.com/guides/helm-sync-jobs/index.md): Automatically discover and monitor Helm charts from a repository using Helm Sync jobs.
- [Monitoring Rules](https://docs.planekeeper.com/guides/rules/index.md): Define staleness thresholds with monitoring rules to detect when deployed software falls behind upstream releases.
- [Scrape jobs](https://docs.planekeeper.com/guides/scrape-jobs/index.md): Set up scrape jobs to extract deployed versions from Git repositories using YQ, JQ, regex, or manual entry.

## Core Concepts

> Core concepts of Planekeeper — how releases, scrape jobs, rule evaluation, alerts, and notifications fit together to monitor software versions.

- [Glossary](https://docs.planekeeper.com/core-concepts/glossary/index.md): Definitions for all key terms used throughout the Planekeeper documentation.
- [How it works](https://docs.planekeeper.com/core-concepts/how-it-works/index.md): The five-stage pipeline that powers Planekeeper's version lag detection, from gathering releases to delivering notifications.
- [Organizations and scoping](https://docs.planekeeper.com/core-concepts/organizations-and-scoping/index.md): How Planekeeper's multi-tenant model works, including organizations, the Global organization, and scope filters.

## Recipes

> Step-by-step Planekeeper recipes for common monitoring scenarios — Helm charts, GitHub releases, manual version tracking, private repos, and more.

- [Access private repositories and registries](https://docs.planekeeper.com/recipes/private-repo-access/index.md): Configure SSH keys, HTTPS tokens, and registry credentials for accessing private Git repositories and container registries.
- [Manual Version Tracking](https://docs.planekeeper.com/recipes/manual-version-tracking/index.md): Track deployed software versions manually without agents, and set up the full monitoring pipeline end-to-end.
- [Monitor GitHub releases](https://docs.planekeeper.com/recipes/monitor-github-releases/index.md): Full walkthrough for monitoring GitHub project releases, including GitHub token setup for higher rate limits.
- [Monitor Helm chart versions](https://docs.planekeeper.com/recipes/monitor-helm-charts/index.md): Step-by-step guide to monitoring Helm chart versions with gather jobs, scrape jobs, rules, and alert configs.
- [Monitor Node.js dependencies](https://docs.planekeeper.com/recipes/monitor-node-dependencies/index.md): Recipe for monitoring Node.js package versions by scraping package.json and tracking upstream releases from GitHub.
- [Send notifications to Discord](https://docs.planekeeper.com/recipes/discord-notifications/index.md): Set up Discord webhook notifications with copy-paste templates for alert events.
- [Send notifications to Slack](https://docs.planekeeper.com/recipes/slack-notifications/index.md): Set up Slack webhook notifications with simple text templates and Block Kit JSON templates for rich formatting.

## Reference

> Planekeeper technical reference — API endpoints, API keys, rule types, parser types, cron expressions, version transforms, and IAM policies.

- [API keys](https://docs.planekeeper.com/reference/api-keys/index.md): API key format, creation, permissions, and best practices for authenticating agents and external integrations.
- [API reference](https://docs.planekeeper.com/reference/api/index.md): Interactive API documentation, OpenAPI specs, and how to authenticate requests via Swagger UI.
- [Cron expressions](https://docs.planekeeper.com/reference/cron-expressions/index.md): Cron expression format reference for scheduling gather and scrape jobs, with common examples and tips for choosing intervals.
- [IAM Policy Documents](https://docs.planekeeper.com/reference/iam-policies/index.md): Reference guide for IAM-style policy documents used in Planekeeper role management.
- [Parser types](https://docs.planekeeper.com/reference/parser-types/index.md): Reference for the four parser types — YQ, JQ, Regex, and Manual — used by scrape jobs to extract or set version strings.
- [Rule types](https://docs.planekeeper.com/reference/rule-types/index.md): Detailed reference for each rule type — days behind, majors behind, and minors behind — including threshold configuration, stable-only filtering, and calculation examples.
- [Settings reference](https://docs.planekeeper.com/reference/settings-reference/index.md): Reference for organization-level settings including default notification channels, template defaults, and task execution configuration.
- [Template variables](https://docs.planekeeper.com/reference/template-variables/index.md): Complete reference of template variables available in notification templates, organized by event category with example snippets.
- [Version Transforms](https://docs.planekeeper.com/reference/version-transforms/index.md): Reference for version transform options that normalize version strings extracted by scrape jobs.

## Troubleshooting

> Troubleshoot Planekeeper. Common issues, FAQ entries, and step-by-step diagnostics for agents, scrape jobs, alerts, and notification deliveries.

- [Common issues](https://docs.planekeeper.com/troubleshooting/common-issues/index.md): Diagnosis and fixes for common issues with agents, jobs, alerts, notifications, and the UI.
- [Frequently asked questions](https://docs.planekeeper.com/troubleshooting/faq/index.md): Answers to frequently asked questions about scheduling, agents, private repos, rate limits, alerts, notifications, and more.

## Optional

- [Tag: Notifications](https://docs.planekeeper.com/tags/notifications/)
- [Tag: Reference](https://docs.planekeeper.com/tags/reference/)
- [Tag: Recipes](https://docs.planekeeper.com/tags/recipes/)
- [Tag: Scrape-Jobs](https://docs.planekeeper.com/tags/scrape-jobs/)
- [Tag: Alerts](https://docs.planekeeper.com/tags/alerts/)
- [Tag: Webhooks](https://docs.planekeeper.com/tags/webhooks/)
- [Tag: Agents](https://docs.planekeeper.com/tags/agents/)
- [Tag: Gather-Jobs](https://docs.planekeeper.com/tags/gather-jobs/)
- [Tag: Guides](https://docs.planekeeper.com/tags/guides/)
- [Tag: Templates](https://docs.planekeeper.com/tags/templates/)
- [Tag: Authentication](https://docs.planekeeper.com/tags/authentication/)
- [Tag: Configuration](https://docs.planekeeper.com/tags/configuration/)
- [Tag: Core-Concepts](https://docs.planekeeper.com/tags/core-concepts/)
- [Tag: Getting-Started](https://docs.planekeeper.com/tags/getting-started/)
- [Tag: Helm](https://docs.planekeeper.com/tags/helm/)
- [Tag: Monitoring](https://docs.planekeeper.com/tags/monitoring/)
- [Tag: Rules](https://docs.planekeeper.com/tags/rules/)
- [Tag: Troubleshooting](https://docs.planekeeper.com/tags/troubleshooting/)
- [Tag: Version-Tracking](https://docs.planekeeper.com/tags/version-tracking/)
- [Tag: Discord](https://docs.planekeeper.com/tags/discord/)
- [Categories index](https://docs.planekeeper.com/categories/)
- [Tags index](https://docs.planekeeper.com/tags/)