Docs

Setup Guide

Install, configure, and launch Vail on your server or hosting environment.

This guide walks you through deploying Vail on your infrastructure, whether using a Linux VPS, Docker, or Node.js process managers.

Prerequisites

Vail requires Node.js v20 or newer (or Bun). Verify your installation with node -v.

  • Node.js v20+ or Bun runtime
  • Git for cloning or pulling updates
  • A public domain or reverse proxy (such as Nginx, Caddy, or Cloudflare Tunnel) if exposing publicly

Installation

Download your Vail release package (vail.zip) and extract it into your deployment folder:

  1. Extract the package into your target folder:

    unzip vail.zip -d /var/www/vail
cd /var/www/vail

  2. Install dependencies:

    npm install

  3. Build the Next.js production bundle:

    npm run build

  4. Start the production server:

    npm start

Verification

Once started, open your browser and navigate to:

http://localhost:3000

You should see your status page rendered with dark mode active by default. Proceed to the Configuration guide to customize your site title, theme colors, and services.

Overview

A sleek, modern self-hosted status page to easily monitor and share service uptimes.

Configuration

A complete reference for settings.json options, site branding, theme colors, and placeholders.

On this page

PrerequisitesInstallationVerification