# Dockflow

> A powerful deployment framework that simplifies Docker deployments to remote servers using Docker Swarm.

## Getting Started
- [Getting Started](https://dockflow.shawiizz.dev/getting-started.md): Dockflow deploys to a single server or a multi-node cluster — same workflow. All you need to get started is one Linux server.

## Configuration
- [Configuration](https://dockflow.shawiizz.dev/configuration.md): Start with your project configuration, then define your servers and Docker Compose stack. The remaining topics are optional and can be explored as ...
- [Connection](https://dockflow.shawiizz.dev/configuration/connection.md): See the [Servers & Connections](/configuration/servers) page for: - [Connection strings](/configuration/servers#ci-secrets)
- [Servers Configuration](https://dockflow.shawiizz.dev/configuration/servers.md): The `servers.yml` file defines your server topology (roles, tags) and environment variables. Connection credentials are provided separately via **c...
- [Environment Variables](https://dockflow.shawiizz.dev/configuration/environment.md): See the [Servers & Connections](/configuration/servers) page for: - [Defining variables per environment](/configuration/servers#environment-variables)
- [Docker Compose](https://dockflow.shawiizz.dev/configuration/docker-compose.md): Dockflow uses a standard `docker-compose.yml` file located at `.dockflow/docker/docker-compose.yml`. This file defines your application services, n...
- [Accessories (Databases, Caches)](https://dockflow.shawiizz.dev/configuration/accessories.md): Accessories are **stateful services** (databases, caches, message queues, etc.) that have a separate lifecycle from your main application. They are...
- [Build Strategy](https://dockflow.shawiizz.dev/configuration/build-strategy.md): Dockflow supports different strategies for building and transferring Docker images to your servers.
- [Docker Registry](https://dockflow.shawiizz.dev/configuration/registry.md): A Docker registry stores your images centrally so Swarm nodes can pull them independently.
- [Templates](https://dockflow.shawiizz.dev/configuration/templates.md): Dockflow renders files with Jinja2 templating before deployment, injecting environment-specific values into your configuration.
- [Hooks](https://dockflow.shawiizz.dev/configuration/hooks.md): Hooks allow you to run custom scripts at specific points during deployment.
- [Multi-Host Deployment](https://dockflow.shawiizz.dev/configuration/multi-host.md): Deploy your application across multiple servers using Docker Swarm with managers and workers.
- [Configuration File](https://dockflow.shawiizz.dev/configuration/config-file.md): The `config.yml` file defines your project identity, build options, health checks, and deployment behavior. This is the first file to configure in ...

## Deployment
- [Deployment](https://dockflow.shawiizz.dev/deployment.md): When you run `dockflow deploy`, Dockflow builds your Docker images, transfers them to your server, deploys the stack via Docker Swarm, and verifies...

## CLI Commands
- [CLI Commands](https://dockflow.shawiizz.dev/cli.md): Dockflow provides a comprehensive CLI for managing deployments and interacting with running services.

## Advanced Usage
- [Advanced Usage](https://dockflow.shawiizz.dev/advanced.md): Operational patterns for managing deployments beyond the basics.

## AI Integration
- [AI Integration](https://dockflow.shawiizz.dev/ai.md): Dockflow provides first-class support for AI assistants through the [llms.txt standard](https://llmstxt.org/) and a dedicated [MCP server](https://...

## Examples
- [Examples](https://dockflow.shawiizz.dev/examples.md): Complete configuration examples for common deployment scenarios.