# Documentation


- **Getting started**
- [Overview](/docs): A local, read-only registry mirror proxy for dockerd.
- [Installation](/docs/installation): Install, update, or uninstall on Linux, macOS, FreeBSD, and Windows.
- [Docker deployment](/docs/docker): Deploy with Docker Compose, configure the host, and build locally.
- [macOS installation and services](/docs/macos-installation): Manage launchd services, Docker Desktop integration, and permissions on macOS.

- **Guides**
- [Automatic Docker integration](/docs/docker-integration): Connect a local Docker Engine or Docker Desktop and safely revert changes.
- [Remote mirror catalogs](/docs/remotes): Subscribe to regional mirror catalogs and manage local choices.
- [Operations](/docs/operations): Commands, Docker integration, service management, and troubleshooting.

- **Reference**
- [Configuration reference](/docs/configuration): Configuration keys, defaults, authentication, and safe reloads.
- [Architecture](/docs/architecture): Components, request flow, failure handling, and security boundaries.
- [Testing](/docs/testing): Run project checks and smoke-test a real proxy binary.