# Nixploy

> Self-hosted PaaS: deploy applications, compose stacks and databases onto your own
> Docker Swarm, with Traefik routing, TLS, backups and observability. One process, one
> box, no per-seat pricing. Everything below is the operator documentation.

Nixploy is driven three ways, all through the same routers, so the organization scope,
the capability checks and the audit trail apply identically to each:

- **MCP** at `https://<your-panel>/api/mcp` — the right surface for an agent. Tools carry
  behaviour annotations, and `deploy_and_wait`, `explain_last_failure`,
  `get_service_runtime_summary` and `get_service_events` answer in one call what would
  otherwise be a polling loop.
- **REST** at `https://<your-panel>/api/<router>.<procedure>` with an `x-api-key` header.
- **CLI**: `npm i -g @nixploy/cli`.

See https://nixploy.com/agents.md for how to drive it as an agent, and https://nixploy.com/agents for
what that looks like end to end.

## Docs

- [Install](https://nixploy.com/docs/install.md): One command on a Linux host. Docker Swarm, Traefik, Postgres, and the panel.
- [Getting started](https://nixploy.com/docs/getting-started.md): From first login to a live service with a domain.
- [Migrate from another panel](https://nixploy.com/docs/migrate.md): Import one environment over the source panel's API where the importer speaks it, recreate the rest, cut DNS when green.
- [Deploy & build](https://nixploy.com/docs/deploy.md): Sources, builders, the durable queue, hooks, rollbacks and runtime options.
- [Domains & TLS](https://nixploy.com/docs/domains.md): Traefik routing, Let's Encrypt, wildcards, middlewares and free smoke hosts.
- [TCP & UDP routing](https://nixploy.com/docs/tcp-udp-routing.md): Layer-4 routes through Traefik: entrypoints, HostSNI, TLS modes.
- [Git & preview deployments](https://nixploy.com/docs/git.md): Provider apps, auto-deploy webhooks, and fork-gated PR previews.
- [Templates](https://nixploy.com/docs/templates.md): 146 one-click compose stacks across 15 categories, plus your own catalogs.
- [Databases](https://nixploy.com/docs/databases.md): Managed Postgres, MySQL, MariaDB, MongoDB, and Redis on Swarm.
- [Backups](https://nixploy.com/docs/backups.md): Database dumps, volume archives, run history, and instance self-backup.
- [Observability](https://nixploy.com/docs/observability.md): Logs, metrics history, Prometheus, terminal, the service event timeline, alerts, uptime, and incidents.
- [Servers & Docker](https://nixploy.com/docs/servers.md): Remote Swarm nodes, placement, SSH transport, and the Docker control center.
- [Auth & security](https://nixploy.com/docs/security.md): Organizations, roles, capabilities, 2FA, SSO, audit, and encrypted secrets.
- [Put any app behind the panel login](https://nixploy.com/docs/forward-auth.md): One switch on a domain and it is behind your organization's sign-in, with your 2FA and SSO rules.
- [Teams & project access](https://nixploy.com/docs/teams.md): Give a member access to some projects and not others, without inventing a new role.
- [Outbound requests](https://nixploy.com/docs/private-egress.md): The egress policy, and the instance-admin toggle that widens it.
- [Key rotation](https://nixploy.com/docs/key-rotation.md): Replacing ENCRYPTION_KEY without downtime, and without losing a secret.
- [Schedules & notifications](https://nixploy.com/docs/schedules.md): Cron jobs, standalone image jobs, and multi-channel alerts.
- [Troubleshooting](https://nixploy.com/docs/troubleshooting.md): Symptom-keyed runbook for the panel, Traefik, deployments and restores.
- [CLI](https://nixploy.com/docs/cli.md): @nixploy/cli — the whole panel from your terminal, scriptable.
- [GitOps](https://nixploy.com/docs/gitops.md): Export, plan, and apply stack desired-state as nixploy.yaml.
- [MCP](https://nixploy.com/docs/mcp.md): Model Context Protocol server for AI agents that need to operate Nixploy.
- [Deploy Copilot](https://nixploy.com/docs/ai.md): BYO LLM key — explain failures, chat actions, and generate compose.

## Optional

- [Templates](https://nixploy.com/templates): 146 reviewed Compose stacks, one page each —
  what each one runs, which variables it asks for and how to back it up.
- [Everything, in one file](https://nixploy.com/llms-full.txt)
- [API catalog](https://nixploy.com/api)
- [Source](https://github.com/bablilayoub/nixploy)