Skip to content

configuration-reference.md

Latest commit

 

History

History
162 lines (119 loc) · 4.47 KB

configuration-reference.md

File metadata and controls

162 lines (119 loc) · 4.47 KB

Configuration Reference

Complete shipnode.conf reference with all options.

Minimal Examples

Backend

APP_TYPE=backend
SSH_USER=root
SSH_HOST=123.45.67.89
REMOTE_PATH=/var/www/myapp
PM2_APP_NAME=myapp
BACKEND_PORT=3000

Frontend

APP_TYPE=frontend
SSH_USER=root
SSH_HOST=123.45.67.89
REMOTE_PATH=/var/www/myapp
DOMAIN=myapp.com

All Configuration Options

Required

Variable Type Description
APP_TYPE string backend or frontend
SSH_USER string SSH username
SSH_HOST string Server IP or hostname
REMOTE_PATH string Deploy path on server

SSH

Variable Type Default Description
SSH_PORT number 22 SSH port
SSH_KEY string ~/.ssh/id_rsa Path to SSH private key

Backend Options

Variable Type Default Description
PM2_APP_NAME string - PM2 process name
BACKEND_PORT number 3000 Application port

Frontend Options

Variable Type Default Description
DOMAIN string - Domain for HTTPS
BUILD_DIR string auto Build output directory

Node.js

Variable Type Default Description
NODE_VERSION string lts Node.js version
PKG_MANAGER string auto npm, yarn, pnpm, or bun

Zero-Downtime

Variable Type Default Description
ZERO_DOWNTIME boolean true Enable atomic deployments
KEEP_RELEASES number 5 Old releases to keep

Health Checks

Variable Type Default Description
HEALTH_CHECK_ENABLED boolean true Enable health checks
HEALTH_CHECK_PATH string /health Health endpoint
HEALTH_CHECK_TIMEOUT number 30 Seconds per attempt
HEALTH_CHECK_RETRIES number 3 Attempts before rollback

Hooks

Variable Type Description
PRE_DEPLOY_SCRIPT string Path to pre-deploy hook
POST_DEPLOY_SCRIPT string Path to post-deploy hook

Database and Redis Setup

When DB_SETUP_ENABLED=true, shipnode setup provisions the selected database on the remote server. DB_TYPE supports postgresql, mysql, and sqlite. PostgreSQL/MySQL setup creates the configured database and user. SQLite setup installs sqlite3 and creates the database file. Redis is independent and enabled with REDIS_SETUP_ENABLED=true.

Variable Type Default Description
DB_SETUP_ENABLED boolean false Enable database setup during shipnode setup
DB_TYPE string postgresql postgresql, mysql, or sqlite
DB_NAME string - PostgreSQL/MySQL database to create
DB_USER string - PostgreSQL/MySQL database user to create
DB_PASSWORD string - PostgreSQL/MySQL password for DB_USER
DB_SQLITE_PATH string $REMOTE_PATH/shared/database.sqlite SQLite database path
REDIS_SETUP_ENABLED boolean false Enable Redis setup during shipnode setup

PostgreSQL/MySQL example:

DB_SETUP_ENABLED=true
DB_TYPE=postgresql
DB_NAME=myapp_db
DB_USER=myapp_user
DB_PASSWORD=${DB_PASSWORD:-}

SQLite example:

DB_SETUP_ENABLED=true
DB_TYPE=sqlite
DB_SQLITE_PATH=/var/www/myapp/shared/database.sqlite

Redis example:

REDIS_SETUP_ENABLED=true

Run schema migrations from .shipnode/pre-deploy.sh; database creation and migrations are separate steps.

Keep SQLite files under shared/ so they survive release switches and cleanup. ShipNode rejects paths inside $REMOTE_PATH/current/ or $REMOTE_PATH/releases/.

Advanced

Variable Type Description
PM2_INSTANCES string max for cluster mode
PM2_MAX_MEMORY string Memory limit (e.g., 1G)
CADDY_ADDITIONAL_CONFIG string Extra Caddy directives

Environment Variables

shipnode.conf is sourced as bash:

PROJECT_NAME=myapp
DOMAIN=api.$PROJECT_NAME.com
REMOTE_PATH=/var/www/$PROJECT_NAME

Multiple Environments

shipnode.conf           # production
shipnode.staging.conf   # staging
shipnode.dev.conf       # development

Deploy with:

shipnode deploy --profile staging