Getting Started

Installation

Learn how to install and configure nuxt-coolify in your Nuxt application.

Quickstart

Follow the steps below to install nuxt-coolify in your Nuxt application.

Package Installation

pnpm add nuxt-coolify

npm install nuxt-coolify

yarn add nuxt-coolify

The module is currently in alpha and only available over NPM/PNPM/Yarn.

Configuration

Add nuxt-coolify to your modules in your nuxt.config.ts:

export default defineNuxtConfig({
  modules: ['nuxt-coolify'],
})

Add the required Coolify environment variables in your .env file:

NUXT_COOLIFY_INSTANCES_DEFAULT_BASE_URL=<your-coolify-url>
NUXT_COOLIFY_INSTANCES_DEFAULT_API_TOKEN=<your-coolify-api-token>
NUXT_COOLIFY_PROVIDERS_HETZNER_BASE_URL=<your-hetzner-api-url>
NUXT_COOLIFY_PROVIDERS_HETZNER_API_TOKEN=<your-hetzner-api-token>

To get your Coolify API token, navigate to the API section in your Coolify Dashboard and create one there.

Introduction

Integrate Nuxt With Coolify to simplify your deployments.

Basic Usage

Learn how to use nuxt-coolify to interact with your Coolify instance.