# Argo Watcher

> Documentation for Argo Watcher - a feedback loop for your GitOps workflow

Argo Watcher is a feedback loop for your GitOps workflow. It bridges the gap between your CI pipeline and Argo CD, reporting real-time deployment status back to the pipeline and optionally updating image tags in your GitOps repository.

## Getting Started

- [Overview](https://argo-watcher.readthedocs.io/en/latest/getting-started/index.md): Starting point for new users.
- [Quick Start](https://argo-watcher.readthedocs.io/en/latest/getting-started/quick-start/index.md): Run a local instance in five minutes with Docker Compose.
- [Concepts](https://argo-watcher.readthedocs.io/en/latest/getting-started/concepts/index.md): The problem Argo Watcher solves, its parts, and the task lifecycle.

## Guides

- [Overview](https://argo-watcher.readthedocs.io/en/latest/guides/index.md): Index of task-oriented guides.
- [Installation](https://argo-watcher.readthedocs.io/en/latest/guides/install/index.md): Installing the server and client.
- [GitOps Updater](https://argo-watcher.readthedocs.io/en/latest/guides/gitops-updater/index.md): Configuring the GitOps Updater to commit image tag changes.
- [Notifications](https://argo-watcher.readthedocs.io/en/latest/guides/notifications/index.md): Sending deployment notifications via webhook or Mattermost.
- [Deployment Lock](https://argo-watcher.readthedocs.io/en/latest/guides/deployment-lock/index.md): Freezing deployments on a schedule or on demand.
- [OIDC / SSO](https://argo-watcher.readthedocs.io/en/latest/guides/oidc/index.md): Securing the Web UI with OIDC (Keycloak, Authentik, or any OIDC provider).

## Reference

- [Overview](https://argo-watcher.readthedocs.io/en/latest/reference/index.md): Index of technical reference material.
- [API Reference](https://argo-watcher.readthedocs.io/en/latest/reference/api/index.md): REST API endpoints, authentication, and health probes.
- [Server Variables](https://argo-watcher.readthedocs.io/en/latest/reference/server-env/index.md): Server environment variables.
- [Client Variables](https://argo-watcher.readthedocs.io/en/latest/reference/client-env/index.md): Client environment variables.
- [Annotations](https://argo-watcher.readthedocs.io/en/latest/reference/annotations/index.md): The argo-watcher/* annotations on an Argo CD Application.

## Operations

- [Overview](https://argo-watcher.readthedocs.io/en/latest/operations/index.md): Index of operational guides.
- [Observability](https://argo-watcher.readthedocs.io/en/latest/operations/observability/index.md): Prometheus metrics, suggested alerts, and an example Grafana dashboard.
- [Database](https://argo-watcher.readthedocs.io/en/latest/operations/database/index.md): Schema, migrations, backups, sizing, and retention.
- [Troubleshooting](https://argo-watcher.readthedocs.io/en/latest/operations/troubleshooting/index.md): Diagnosing common problems.

## Contributing

- [Overview](https://argo-watcher.readthedocs.io/en/latest/contributing/index.md): How to contribute.
- [Development](https://argo-watcher.readthedocs.io/en/latest/contributing/development/index.md): Setting up a development environment.
- [Style Guide](https://argo-watcher.readthedocs.io/en/latest/contributing/style/index.md): Documentation style guide.