Getting Started

Deploynix provisions Laravel-ready servers on your own cloud account and deploys your applications to them with zero downtime. This guide walks you from an empty account to your first live site.

What Deploynix Does

You bring a cloud account — DigitalOcean, Hetzner, Vultr, Linode, AWS — or an existing server. Deploynix takes it from there: it installs a full web stack, deploys your sites from Git with atomic releases, issues and renews SSL certificates, manages databases, queue workers and scheduled tasks, runs backups, monitors health, and keeps your team in sync — all from a single dashboard.

Core Concepts

A small glossary so the rest of these docs make sense:

• Organization — your top-level workspace. Billing, members, servers, and sites all live inside an organization. You can belong to (and switch between) multiple organizations.
• Server — a machine Deploynix provisioned on your cloud account, or an existing server you connected by SSH. Each server has a type that decides which software gets installed.
• Site — a single application running on a server. A site has a project type (Laravel, WordPress, Node, etc.), one or more domains, an optional Git repository, environment variables, and a deploy script.
• Deployment — one run of a site's deploy script. Deployments are atomic, released from a fresh directory, and rollback-able to any previous build.

Step 1 — Create Your Account

1. Register at the sign-up page.
2. Verify your email address using the link we send you.
3. Pick a plan on the onboarding screen. A free tier is available; paid plans unlock higher limits on servers, sites, team members, databases, cron jobs, daemons, and SSH keys. See Billing & Plans for details.
4. You land inside your first organization. You can create more organizations later from the workspace switcher.

Step 2 — Connect a Cloud Provider

Deploynix provisions servers on your behalf using API credentials you provide. Connect at least one provider before creating a server.

Supported Providers

• DigitalOcean — personal access token
• Vultr — API key
• Linode — personal access token
• Hetzner — API token (Hetzner Cloud project)
• AWS — access key ID and secret access key (EC2)
• Custom Server — connect an existing machine over SSH, no credentials required

For exact scopes, IAM permissions, and step-by-step setup for each provider, see the Provider Permissions reference.

Adding a Provider

1. Go to Settings → Server Providers.
2. Click Add Provider and choose the cloud.
3. Paste the API credentials.
4. Click Save. The credentials are encrypted at rest and can be rotated at any time.

Step 3 — Create Your First Server

From the dashboard, open Servers and click Create Server. You will pick a provider, region, size, and — important — a server type. The type determines what Deploynix installs.

Server Types

• App Server — full stack: Nginx, PHP, a database (MySQL / MariaDB / PostgreSQL), Valkey, Node.js, Supervisor. The right choice for a single-box Laravel app.
• Web Server — Nginx, PHP, Node.js, Supervisor. No local database or cache — pair with a dedicated Database Server.
• Database Server — dedicated MySQL, MariaDB, or PostgreSQL with remote access enabled.
• Cache Server — dedicated Valkey (Redis-compatible) accessible from your other servers.
• Worker Server — PHP and Supervisor for running Horizon, queue workers, and background jobs.
• Meilisearch Server — dedicated Meilisearch search engine behind an HTTPS reverse proxy.
• Load Balancer — an Nginx load balancer that distributes traffic across backend servers.

Step 4 — Deploy Your First Site

Once the server is ready, open it and head to the Sites tab.

1. Click Create Site.
2. Pick a project type: Laravel, WordPress, Statamic, General PHP, Static, or a JavaScript framework — React, Vue, Angular, Svelte, Next.js, Nuxt.js, SvelteKit, or Angular SSR.
3. Enter the primary domain (and any aliases).
4. Connect a Git repository — GitHub, GitLab, Bitbucket, or a custom Git server — and choose a branch. See Git Integration for OAuth setup.
5. Review the generated deploy script. Customize it if you need to run migrations, rebuild assets, clear caches, or restart queues.
6. Click Deploy.

Every deploy is atomic: Deploynix builds the new release in a fresh directory and switches traffic over only when it's ready. You can roll back to any previous release with a single click, and you can enable webhook auto-deploy so every git push ships automatically. Details in Deployments.

Step 5 — Go Further

Everything else you'll want in your first week: