> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wpautoflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart & Installation

> Get WP AutoFlow running on your VPS in under 5 minutes.

WP AutoFlow is designed to be deployed using Docker, ensuring that the Node.js application, MongoDB, and Redis run together perfectly in isolated containers.

## 🚀 The First Access Rule (Important!)

**WP AutoFlow has no default password.** The very first time the application is launched, the first person to access `http://YOUR_SERVER_IP:3000` will be prompted to create the Master Admin account.

> ⚠️ **Security Warning:** Do this immediately after the installation finishes. If you leave the port open and unattended, an automated bot could claim the admin account.

***

## Method 1: Standard Installation (Recommended)

The standard and most reliable way to get started. This will clone the repository and build the containers locally on your server.

**1. Prerequisites**

* A VPS running Ubuntu 22.04 or 24.04 (Contabo, DigitalOcean, Hetzner, etc.).
* Docker and Docker Compose V2 installed.

**2. Installation Steps**

Clone the repository and configure your environment:

```bash theme={null}
git clone https://github.com/wp-autoflow/wp-autoflow.git
cd wp-autoflow
cp .env.example .env
```

Start the system using Docker Compose:

```bash theme={null}
docker compose up -d --build
```

The system is now running on `http://YOUR_SERVER_IP:3000`.

***

## Method 2: Easypanel 1-Click ✨

If you use Easypanel to manage your server, you can deploy WP AutoFlow with a single click. Easypanel provides a beautiful GUI and automated free SSL certificates.

1. Log in to your [Easypanel](https://easypanel.io) dashboard.
2. Go to **Templates**, search for **WP AutoFlow**, and click **Deploy**.
3. The system will automatically pull the official image, set up MongoDB and Redis, and link all internal variables.
4. Once the deployment is green, click on your project domain and create your admin account.

***

## Method 3: Official Docker Image 🐳

If you are already running a Docker Swarm, Portainer, or your own Compose stack, you can grab our official, pre-compiled image directly from Docker Hub. No compilation needed.

🔗 **[WP AutoFlow on Docker Hub](https://hub.docker.com/r/fabioselau/wp-autoflow)**

**Image Tag:** `fabioselau/wp-autoflow:latest`

*Note: The application requires MongoDB and Redis to function. Ensure you link these services in your environment variables.*

***

## 🔒 Secure your instance (Reverse Proxy & SSL)

**Never expose port 3000 directly to the internet in a production environment.** You must use a Reverse Proxy to secure your credentials and API keys with an SSL certificate (HTTPS).

Here are the two industry-standard methods:

### Option A: Nginx Proxy Manager (GUI)

The easiest method if you prefer a visual interface.

1. Install [Nginx Proxy Manager](https://nginxproxymanager.com/).
2. Add a new Proxy Host pointing to your domain (e.g., `app.yourdomain.com`).
3. Set the Forward Hostname/IP to your WP AutoFlow server IP and the port to `3000`.
4. Enable "Request a new SSL Certificate" in the SSL tab.

### Option B: Caddy Server (CLI)

If you prefer a lightweight CLI approach with automated SSL provisioning:

1. Install [Caddy](https://caddyserver.com/docs/install).
2. Open your `Caddyfile` and add:

```nginx theme={null}
app.yourdomain.com {
    reverse_proxy localhost:3000
}
```

3. Restart Caddy. It will automatically fetch an SSL certificate for you.

```
```