Skip to content

fcakyon/claude-codex-settings / plugins/dokploy-skills/skills/dokploy-deploy

dokploy-deploy

Flagged

This skill should be used when user asks to "deploy with Dokploy", "use Dokploy Cloud", "manage self-hosted Dokploy", "deploy Docker Compose on Dokploy", "manage Dokploy databases", "configure Dokploy domains", or "look up Dokploy CLI commands".

FileKindSize
SKILL.mdskill md3.6 KB
references/applications/advanced.mdxmarkdown13.8 KB
references/applications/build-type.mdxmarkdown9.0 KB
references/applications/going-production.mdxmarkdown7.0 KB
references/applications/index.mdxmarkdown4.3 KB
references/applications/meta.jsonconfig155 B
references/applications/preview-deployments.mdxmarkdown3.9 KB
references/applications/rollbacks.mdxmarkdown6.0 KB
references/applications/zero-downtime.mdxmarkdown2.9 KB
references/cli-commands.mdmarkdown34.3 KB
references/cloud/cloud.mdxmarkdown5.3 KB
references/databases/backups.mdxmarkdown1.3 KB
references/databases/connection/index.mdxmarkdown1.8 KB
references/databases/connection/mariadb.mdxmarkdown859 B
references/databases/connection/mongo-atlas.mdxmarkdown795 B
references/databases/connection/mysql.mdxmarkdown852 B
references/databases/connection/pg-admin.mdxmarkdown1020 B
references/databases/connection/redis.mdxmarkdown772 B
references/databases/index.mdxmarkdown4.3 KB
references/databases/restore.mdxmarkdown1.9 KB
references/docker-compose/domains.mdxmarkdown11.1 KB
references/docker-compose/example.mdxmarkdown4.1 KB
references/docker-compose/index.mdxmarkdown8.4 KB
references/docker-compose/utilities.mdxmarkdown2.6 KB
references/domains/cloudflare.mdxmarkdown6.5 KB
references/domains/generated.mdxmarkdown1.3 KB
references/domains/index.mdxmarkdown11.7 KB
references/domains/others.mdxmarkdown1.7 KB
references/getting-started/installation.mdxmarkdown8.9 KB
references/getting-started/manual-installation.mdxmarkdown16.8 KB
references/remote-servers/build-server.mdxmarkdown5.5 KB
references/remote-servers/deployments.mdxmarkdown1.4 KB
references/remote-servers/index.mdxmarkdown3.4 KB
references/remote-servers/instructions.mdxmarkdown4.4 KB
references/remote-servers/security.mdxmarkdown2.7 KB
references/remote-servers/validate.mdxmarkdown2.4 KB

references/getting-started/installation.mdx

View on GitHub
---
title: Installation
description: "Get Dokploy up and running on your server within minutes with this easy-to-follow installation guide."
---

Follow these steps in order to set up Dokploy locally and deploy it to your server, effectively managing Docker containers and applications:

You need to follow this steps in the same order:

1. [Virtual Private Server (VPS)](#virtual-private-server-vps)

## Virtual Private Server (VPS)

There are multiple VPS providers to choose from:

We have tested on the following Linux Distros:

- Ubuntu 24.04 LTS
- Ubuntu 23.10
- Ubuntu 22.04 LTS
- Ubuntu 20.04 LTS
- Ubuntu 18.04 LTS
- Debian 12
- Debian 11
- Debian 10
- Fedora 40
- Centos 9
- Centos 8

### Providers

- [Hostinger](https://www.hostinger.com/vps-hosting?ref=dokploy) Get 20% Discount using this referral link: [Referral Link](https://www.hostinger.com/vps-hosting?REFERRALCODE=1SIUMAURICI97)
- [AmericanCloud](https://app.americancloud.com/register?ref=dokploy) Receive 20$ credits for free: [Referral Link](https://app.americancloud.com/register?ref=dokploy)
- [Teramont](https://teramont.net/dokploy) Get 15% discount for free: [Referral Link](https://teramont.net/?partner_coupon=DOKPLOY&aff_link=https%3A%2F%2Fbilling.teramont.net%2Faff.php%3Faff%3D53%26url%3Dhttps%3A%2F%2Fteramont.net%2Fdokploy-hosting)
- [Hetzner](https://www.hetzner.com/cloud/) Get 20€ credits for free with this referral link: [Referral Link](https://hetzner.cloud/?ref=vou4fhxJ1W2D)
- [DigitalOcean](https://www.digitalocean.com/pricing/droplets#basic-droplets) Get 200$ credits for free with this referral link: [Referral Link](https://m.do.co/c/7613f9ec4e85)
- [Vultr](https://www.vultr.com/pricing/#cloud-compute) Referral Link: [Referral Link](https://www.vultr.com/?ref=9679828)
- [Linode](https://www.linode.com/es/pricing/#compute-shared)
- [Scaleway](https://www.scaleway.com/en/pricing/?tags=baremetal,available)
- [Google Cloud](https://cloud.google.com/)
- [AWS](https://aws.amazon.com/ec2/pricing/)

### Requirements

To ensure a smooth experience with Dokploy, your server should have at least 2GB of RAM and 30GB of disk space. This specification helps to handle the resources consumed by Docker during builds and prevents system freezes.

import { Callout } from "fumadocs-ui/components/callout";

<Callout>
  **Suggestion:** For cost efficiency with reliable service, we recommend
  Hetzner as the best value-for-money VPS provider.
</Callout>

### Port Requirements

Before installing Dokploy, ensure the following ports are available on your server:

- **Port 80**: HTTP traffic (used by Traefik)
- **Port 443**: HTTPS traffic (used by Traefik)
- **Port 3000**: Dokploy web interface

<Callout type='warn'>
  **Important:** The installation will fail if any of these ports are already in use. Make sure to stop any services using these ports before running the installation script.
</Callout>

### Docker

Dokploy utilizes Docker, so it is essential to have Docker installed on your server. If Docker is not already installed, Dokploy's installation script will install it automatically. Use the following command to install Dokploy:


<div className="flex flex-col gap-10 px-4 bg-green-200 dark:bg-[#031F10] text-green-900 dark:text-green-300 rounded-lg">

 Dokploy Cloud:  Use Dokploy directly without worrying about maintenance or updates. Enjoy a hassle-free experience with Dokploy Cloud.  <a href="https://app.dokploy.com/register" className="text-green-600 underline">Sign up</a>
</div>

```bash
curl -sSL https://dokploy.com/install.sh | sh
```

See [Manual Installation](/docs/core/manual-installation) if you want to customize your Dokploy installation.


### Advanced Installation Options

The installation script automatically detects and installs the latest stable version from GitHub. However, you can customize the installation using environment variables:

#### Install Specific Versions

**Install Canary Version (Development):**
```bash
export DOKPLOY_VERSION=canary && curl -sSL https://dokploy.com/install.sh | sh
```

**Install Latest Stable:**
```bash
export DOKPLOY_VERSION=latest && curl -sSL https://dokploy.com/install.sh | sh
```

**Install a Specific Version:**

Every [Dokploy release](https://github.com/Dokploy/dokploy/releases) includes its own `install.sh` as a release asset, which installs exactly that version with the setup it expects. Replace the version tag in the URL with the one you want:

```bash
curl -sL https://github.com/Dokploy/dokploy/releases/download/v0.26.6/install.sh | sh
```

<Callout type='info'>
  Don't use `DOKPLOY_VERSION` to install a specific version — the main script at `dokploy.com/install.sh` always targets the latest release, so its setup may not be compatible with older versions.
</Callout>

#### Custom Network Configuration

If you need to customize the Docker Swarm network configuration (useful to avoid CIDR conflicts with cloud provider VPCs):

```bash
export DOCKER_SWARM_INIT_ARGS="--default-addr-pool 172.20.0.0/16 --default-addr-pool-mask-length 24"
curl -sSL https://dokploy.com/install.sh | sh
```

#### Manual Advertise Address

If the script cannot detect your server's IP automatically, or you want the Swarm to use a specific interface (e.g. a VPN/WireGuard IP), specify it manually:

```bash
curl -sSL https://dokploy.com/install.sh | sudo ADVERTISE_ADDR=192.168.1.100 sh
```

<Callout type='warn'>
  If you run the installer with `sudo`, don't rely on `export ADVERTISE_ADDR=...` from your user shell — `sudo` resets the environment, so the variable never reaches the script and it falls back to auto-detection. Pass the variable inline as shown above, or use `sudo -E sh` to preserve your environment. The same applies to `DOKPLOY_VERSION`, `DOCKER_SWARM_INIT_ARGS`, and `ENDPOINT_MODE`.
</Callout>

#### Kernels Without IPVS Support

Docker Swarm's default service discovery requires IPVS support in the kernel. Some minimal or appliance-style distributions (e.g. ZimaOS and other Buildroot-based images) ship kernels without it. On those systems, install with DNSRR endpoint mode:

```bash
curl -sSL https://dokploy.com/install.sh | sudo ENDPOINT_MODE=dnsrr sh
```

See [Services Can't Reach Each Other (Missing IPVS Kernel Modules)](/docs/core/troubleshooting/networking#services-cant-reach-each-other-missing-ipvs-kernel-modules) for how to detect this situation and its trade-offs.

### Proxmox LXC Support

<Callout type='info'>
  The installation script automatically detects Proxmox LXC containers and applies the necessary configurations (`--endpoint-mode dnsrr`) for compatibility.
</Callout>

### Updating Dokploy

To update your Dokploy installation to the latest version:

```bash
curl -sSL https://dokploy.com/install.sh | sh -s update
```

**Update to Specific Version:**

Use the `install.sh` from that version's [GitHub release](https://github.com/Dokploy/dokploy/releases):

```bash
curl -sL https://github.com/Dokploy/dokploy/releases/download/v0.26.6/install.sh | sh -s update
```

## Completing the Setup

After running the installation script, Dokploy and its dependencies will be set up on your server. Here's how to finalize the setup and start using Dokploy:

### Accessing Dokploy

Open your web browser and navigate to `http://your-ip-from-your-vps:3000`. You will be directed to the initial setup page where you can configure the administrative account for Dokploy.

<Callout type='warn'>
    **Important:** Ensure that your server's firewall allows traffic on port
    3000 to access the Dokploy web interface.
</Callout>

### Initial Configuration

1. **Create an Admin Account:** Fill in the necessary details to set up your administrator account. This account will be the admin account for Dokploy.

{" "}

<ImageZoom
  src="/assets/images/setup.webp"
  width={1300}
  height={650}
  alt="home og image"
  className="rounded-lg"
/>

### Secure Your Installation
After setting up your admin account, it's crucial to secure your Dokploy installation by enabling HTTPS.

To configure a domain with SSL/TLS certificates for your Dokploy panel, please refer to the [Domains](/docs/core/domains) section where you'll find detailed instructions for different SSL configurations including Let's Encrypt, Cloudflare, and custom certificates.

### Disable access via ip:port (Optional but Recommended) 
To enhance security, it's advisable to restrict access to Dokploy via the server's IP address and port.

<Callout type='warn'>
    **Important:** Before disabling IP:port access, make sure you have configured a domain with HTTPS working properly. Otherwise, you will lose access to your Dokploy installation. See the [Domains](/docs/core/domains) section to set this up first.
</Callout>

Once you have verified that your domain is working correctly, you can disable IP:port access by running this command on the server:

```bash
docker service update --publish-rm "published=3000,target=3000,mode=host" dokploy
```

To further secure your installation, consider reading the [Security recommendations](/docs/core/remote-servers/security#security-recommendations) section.

writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deploymentStars: 321kUpdated Claude CodeCodexVerifiedInstall
xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release.Stars: 118kUpdated Claude CodeCodexVerifiedInstall