chore: docs & readme -> swarm + k3s

Author: Shawiizz

README.md

@@ -18,9 +18,9 @@
 
 ---
 
-A deployment framework for Docker applications, leveraging Swarm for orchestration.
+A CLI-first deployment framework for Docker applications. Supports Docker Swarm and k3s (Kubernetes) as orchestrators.
 
-Dockflow automates the deployment of containerized applications to remote servers using Docker Swarm. It handles image building, transfer, stack deployment, health monitoring, and automatic rollback.
+Dockflow automates the deployment of containerized applications to remote servers via direct SSH — no runtime dependencies beyond the binary itself. It handles image building, transfer, stack deployment, health monitoring, and automatic rollback.
 
 ## Documentation
 

docs/app/cli/page.mdx

@@ -679,6 +679,14 @@ dockflow setup swarm <env>
 
 Initialize a Docker Swarm cluster for an environment. Joins all servers configured in `servers.yml` into the Swarm.
 
+### Initialize k3s
+
+```bash
+dockflow setup k3s <env>
+```
+
+Install and configure k3s on the target server for an environment.
+
 ### Check Dependencies
 
 ```bash

docs/app/configuration/accessories/page.mdx

@@ -10,7 +10,7 @@ Accessories are **stateful services** (databases, caches, message queues, etc.)
   **Problem**: If you put your database in the main `docker-compose.yml`, it gets restarted on every deployment. This can cause data corruption or downtime.
 </Callout>
 
-**Solution**: Accessories are deployed as a separate Docker Swarm stack. Your app can be deployed 100 times without touching the database.
+**Solution**: Accessories are deployed as a separate stack (Swarm) or namespace (k3s). Your app can be deployed 100 times without touching the database.
 
 ```
 myapp-production              ← Main app (redeployed often)
@@ -61,9 +61,9 @@ volumes:
   Environment variables can be accessed using template syntax: `{{ variable_name }}`
 </Callout>
 
-## Automatic Swarm Configuration
+## Automatic Deploy Configuration
 
-Dockflow automatically injects a minimal Swarm configuration for each accessory service:
+Dockflow automatically injects a minimal deploy configuration for each accessory service:
 
 ```yaml
 deploy:

docs/app/configuration/backup/page.mdx

@@ -162,7 +162,7 @@ backup:
 
 ### Redis
 
-Triggers `BGSAVE` and copies the RDB dump file. Restore writes the new dump file, issues `SHUTDOWN NOSAVE` to prevent Redis from overwriting it, then explicitly restarts the Swarm service via `docker service update --force`.
+Triggers `BGSAVE` and copies the RDB dump file. Restore writes the new dump file, issues `SHUTDOWN NOSAVE` to prevent Redis from overwriting it, then restarts the service (`docker service update --force` on Swarm, `kubectl rollout restart` on k3s).
 
 ```yaml
 backup:

docs/app/configuration/build-strategy/page.mdx

@@ -19,7 +19,7 @@ Images are built in your CI/CD pipeline and transferred to the server via SSH. N
 **How it works:**
 1. Dockflow parses `docker-compose.yml` to extract build commands
 2. Images are built locally (in parallel if multiple services)
-3. Images are streamed to all Swarm nodes via SSH:
+3. Images are streamed to all cluster nodes via SSH:
    ```
    docker save IMAGE | gzip -1 | ssh user@host "gunzip | docker load"
    ```
@@ -32,12 +32,12 @@ This is the simplest strategy and works for both single-node deployments and mul
 
 ## Registry Build
 
-For larger multi-node Swarm clusters, use a Docker registry so all nodes can pull images independently. This avoids streaming large images over SSH to each node individually.
+For larger multi-node clusters, use a Docker registry so all nodes can pull images independently. This avoids streaming large images over SSH to each node individually.
 
 **How it works:**
 1. Images are built locally (same as default)
 2. Images are pushed to your configured registry
-3. During `docker stack deploy`, each Swarm node pulls the image from the registry
+3. During deployment, each node pulls the image from the registry
 
 See [Docker Registry](/configuration/registry) for full configuration (GHCR, GitLab, Docker Hub, self-hosted).
 
@@ -79,7 +79,7 @@ For private repositories, add a `GIT_TOKEN` secret to your CI/CD environment. Do
 | **Setup complexity** | None | Registry config needed | Git access on server |
 | **Network usage** | SSH stream per node | Single push, nodes pull | Git clone only |
 | **Build cache** | Full local cache | Full local cache | Pruned between deploys |
-| **Multi-node** | Streaming to each node | Native Swarm pull | Streaming to workers |
+| **Multi-node** | Streaming to each node | Registry pull per node | Streaming to workers |
 | **CI resources** | Needs Docker on runner | Needs Docker on runner | Minimal CI resources |
 | **Private repos** | N/A | N/A | Needs `GIT_TOKEN` |
 

docs/app/configuration/docker-compose/page.mdx

@@ -71,7 +71,7 @@ This behavior can be disabled with `image_auto_tag: false` in [config.yml](/conf
 
 ## Deploy Configuration
 
-The `deploy` section controls how Docker Swarm manages your services. Dockflow injects sensible defaults, so you only need to specify what you want to override.
+The `deploy` section controls how the orchestrator manages your services. Dockflow injects sensible defaults for Swarm — on k3s these settings are translated to Kubernetes resource equivalents. You only need to specify what you want to override.
 
 ### Default Values
 
@@ -129,7 +129,7 @@ services:
 
 ## Health Checks
 
-Docker health checks let Swarm verify that containers are actually working:
+Docker health checks let the orchestrator verify that containers are actually working:
 
 ```yaml
 services:
@@ -162,7 +162,7 @@ volumes:
 ```
 
 <Callout type="info">
-  Volumes and networks are automatically prefixed with the stack name by Docker Swarm (e.g., `myapp-production_app-data`). No manual prefixing needed.
+  On Swarm, volumes and networks are automatically prefixed with the stack name (e.g., `myapp-production_app-data`). On k3s, resources are scoped to the `dockflow-{stackName}` namespace.
 </Callout>
 
 ## Networks
@@ -260,8 +260,8 @@ networks:
 Dockflow ensures complete isolation between environments (production, staging, etc.) through:
 
 1. **Image names** — automatically tagged with environment and version (`my-app-production:1.0.0`)
-2. **Stack names** — each environment gets its own Swarm stack
-3. **Networks and volumes** — automatically prefixed with the stack name by Docker Swarm
+2. **Stack names** — each environment gets its own isolated stack or namespace
+3. **Networks and volumes** — scoped per stack (Swarm prefix, k3s namespace)
 
 ---
 

docs/app/configuration/multi-host/page.mdx

@@ -2,7 +2,11 @@
 
 import { Callout } from 'nextra/components'
 
-Deploy your application across multiple servers using Docker Swarm with managers and workers.
+Deploy your application across multiple servers. Multi-node clusters are supported for **Docker Swarm**. k3s deployments currently target a single node via dockflow.
+
+<Callout type="info">
+  The orchestrator is selected with `orchestrator: swarm | k3s` in `config.yml`. See [Orchestrator](/configuration/orchestrator) for details.
+</Callout>
 
 ## Swarm Architecture
 
@@ -42,7 +46,7 @@ PRODUCTION_WORKER2_CONNECTION=eyJob3N0Ijoi...
 ```
 
 <Callout type="info">
-  Workers automatically join the Swarm cluster. You only deploy to the manager — Swarm distributes workloads automatically.
+  Workers automatically join the Swarm cluster during `dockflow setup swarm`. You only deploy to the manager — Swarm distributes workloads automatically.
 </Callout>
 
 ## Multi-Manager for High Availability
@@ -83,7 +87,7 @@ servers:
 When deploying with multiple managers, Dockflow automatically:
 
 1. Checks each manager's status via SSH
-2. Finds the Swarm leader (or any reachable manager)
+2. Finds the active Swarm leader (or any reachable manager)
 3. Falls back to the next available manager if one is down
 
 ```bash
@@ -105,12 +109,12 @@ Example output with failover:
 ## How Deployment Works
 
 1. **Deploy targets the manager** — Dockflow connects only to the active manager
-2. **Swarm distributes workloads** — Containers are scheduled across all nodes
+2. **Swarm schedules workloads** — Containers are distributed across all nodes automatically
 3. **Images are transferred to workers** — Via SSH streaming or [registry](/configuration/registry)
 
 ```bash
 dockflow deploy production
-# ✓ Deployment completed! Swarm cluster: 3 managers + 2 worker(s)
+# ✓ Deployment completed! Swarm cluster: 3 managers, 2 worker(s)
 ```
 
 ## Server-Specific Environment Variables

docs/app/getting-started/page.mdx

@@ -63,7 +63,7 @@ You need a Debian/Ubuntu server with SSH access (root or sudo user).
     dockflow setup root@your-server-ip
     ```
 
-    The wizard handles everything: Docker installation, Swarm initialization, SSH keys, and deployment user creation.
+    The wizard handles everything: Docker installation, orchestrator setup (Swarm or k3s), SSH keys, and deployment user creation.
     At the end, it generates a **connection string** — save it for later.
   </Tabs.Tab>
   <Tabs.Tab>

docs/app/page.tsx

@@ -27,7 +27,7 @@ export default function Page() {
 
           <p className="mt-5 text-lg text-neutral-500 dark:text-neutral-400 max-w-[560px] mx-auto leading-relaxed">
             A CLI that scaffolds, provisions, and deploys Docker applications to your own servers.
-            Powered by Docker Swarm. No Kubernetes needed.
+            Supports Docker Swarm and k3s. No cloud vendor lock-in.
           </p>
 
           <div className="flex justify-center gap-3 mt-8 flex-wrap">
@@ -84,7 +84,7 @@ export default function Page() {
           Skip the complexity
         </h2>
         <p className="text-neutral-500 dark:text-neutral-400 text-center text-[15px] mt-3 mb-12">
-          Server provisioning, Swarm orchestration, rollbacks — handled for you.
+          Server provisioning, orchestration, rollbacks — handled for you.
         </p>
 
         <div className="grid grid-cols-1 md:grid-cols-2 gap-5">
@@ -94,7 +94,7 @@ export default function Page() {
               Without Dockflow
             </div>
             {[
-              "Install Docker & init Swarm by hand",
+              "Install Docker & set up the orchestrator by hand",
               "Manage SSH keys and user accounts",
               "Write bash deploy scripts",
               "Transfer images to servers manually",
@@ -115,7 +115,7 @@ export default function Page() {
             </div>
             {[
               ["dockflow init", "Scaffolds config, Compose & Dockerfile"],
-              ["dockflow setup", "Installs Docker, creates user, inits Swarm"],
+              ["dockflow setup", "Installs Docker, creates user, sets up Swarm or k3s"],
               ["Connection strings", "Generated automatically after setup"],
               ["dockflow deploy", "Builds, transfers & deploys via SSH"],
               ["Health checks", "Auto rollback on failure"],
@@ -147,7 +147,7 @@ export default function Page() {
           <FeatureCard
             icon={<IconTerminal />}
             title="One command deploy"
-            desc="dockflow deploy builds your image, transfers it to the server, and updates your Docker Swarm stack — in a single command."
+            desc="dockflow deploy builds your image, transfers it to the server, and deploys your stack via SSH — whether you run Docker Swarm or k3s."
             large
           />
           <FeatureCard
@@ -160,7 +160,7 @@ export default function Page() {
         {/* Row 2: 4 small */}
         <div className="grid grid-cols-1 sm:grid-cols-2 lg:grid-cols-4 gap-4">
           <FeatureCard icon={<IconRollback />} title="Auto rollback" desc="Configurable health checks on deploy. Roll back on failure, notify, or ignore." />
-          <FeatureCard icon={<IconServer />} title="Single node to cluster" desc="Start on one server. Add workers and scale to multi-node Swarm when ready." />
+          <FeatureCard icon={<IconServer />} title="Single node to cluster" desc="Start on one server. Scale to a multi-node Swarm cluster or deploy on k3s when ready." />
           <FeatureCard icon={<IconGitBranch />} title="CI/CD workflows" desc="Ships with ready-made GitHub Actions and GitLab CI pipelines. Push a tag, trigger a deploy." />
           <FeatureCard icon={<IconMonitor />} title="Web dashboard" desc="Monitor services, stream logs, and trigger deploys from the built-in web UI." />
         </div>