Skip to content

Quick Install Guide

Get ANTE ERP up and running in under 5 minutes using the ANTE CLI.

Complete CLI Documentation

For comprehensive CLI documentation, see the CLI Reference Guide. This page covers quick installation only.

Prerequisites

Before installing, ensure your system has:

  • Node.js 24.0+ (LTS, for the CLI)
  • Docker 20.10+
  • Docker Compose v2.0+
  • 4GB RAM minimum (8GB recommended)
  • 20GB free disk space minimum

Don't have these installed? See the Prerequisites Guide for installation instructions.


Installation Steps

Step 1: Install the ANTE CLI

bash
# Install globally using npm
npm install -g ante-erp-cli

# Verify installation
ante --version

Node.js Required

The CLI requires Node.js 24.0 or higher (LTS). If you don't have Node.js installed:

Ubuntu/Debian:

bash
curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
sudo apt-get install -y nodejs
node --version  # Verify

macOS:

bash
brew install node@24
node --version  # Verify

Step 2: Run Installation

bash
# Run the interactive installer
ante install

The installer will:

  1. ✅ Check system requirements (Docker, disk space, memory)
  2. ✅ Generate secure credentials automatically
  3. ✅ Create optimized Docker configuration
  4. ✅ Pull Docker images
  5. ✅ Start all services
  6. ✅ Run database migrations
  7. ✅ Save credentials to installation directory

Installation options:

bash
# Specify installation directory
ante install --dir /opt/ante-erp

# Use non-interactive mode with defaults
ante install --no-interactive

# Enterprise preset with domain
ante install --preset enterprise --domain erp.company.com --email admin@company.com

Step 3: Access ANTE ERP

After installation completes (2-3 minutes), open your browser:

http://localhost:8080

Or if accessing from another computer:

http://YOUR_SERVER_IP:8080

First Time Setup

On first access, you'll need to create an admin account. Follow the on-screen instructions.

Installation credentials are saved to:

bash
cat ./ante-erp/installation-credentials.txt

⚠️ Important: Save this file securely - it contains all your passwords!


Managing Your Installation

Once installed, use these CLI commands:

Check Status

bash
ante status

Shows all services with their health status.

View Logs

bash
# View all logs
ante logs

# Follow logs in real-time
ante logs --follow

# View specific service logs
ante logs --service backend --follow

Restart Services

bash
# Restart all services
ante restart

# Restart specific service
ante restart --service backend

Create Backup

bash
# Create backup of all data
ante backup

# List available backups
ante backup list

Update to Latest

bash
# Update ANTE (automatic backup created)
ante update

# Update CLI tool itself
ante update-cli

Run Health Check

bash
# Check system health
ante doctor

Stop/Start Services

bash
# Stop all services (data preserved)
ante stop

# Start services again
ante start

Default Configuration

After installation, ANTE ERP runs with these defaults:

ComponentAccess URLNotes
Frontendhttp://localhost:8080Main web interface
Backend APIhttp://localhost:3001API endpoints
WebSocketws://localhost:4001Real-time updates

All databases run internally and are not exposed to the host by default.


Post-Installation Steps

After successful installation:

  1. Create Admin Account

  2. Configure System Settings

    • Company information
    • Modules to enable
    • User roles and permissions
  3. Setup SSL/HTTPS (for production)

    bash
    # Configure your domain
    ante set-domain --frontend https://erp.company.com --api https://api.company.com
    
    # Enable SSL with automatic certificates
    ante ssl enable --email admin@company.com
  4. Configure Backups

  5. Import Initial Data

    • Users and departments
    • Projects and clients
    • Asset inventory

Quick Troubleshooting

Installation Fails

bash
# Run diagnostics
ante doctor

# Check Docker status
docker ps
sudo systemctl status docker

Services Won't Start

bash
# Check status
ante status

# View logs for errors
ante logs

# Try restart
ante restart

Can't Access Frontend

bash
# Check if services are running
ante status

# Check port availability
sudo lsof -i :8080

# Check firewall
sudo ufw status

For more help, see the CLI Troubleshooting Guide.


Complete CLI Command Reference

Installation & Setup

bash
ante install                    # Interactive installation
ante install --dir <path>       # Custom directory
ante install --no-interactive   # Non-interactive mode

Service Management

bash
ante status                     # Show service status
ante start                      # Start all services
ante stop                       # Stop all services
ante restart                    # Restart all services
ante logs [--follow]            # View logs
ante doctor                     # Run health checks

Backup & Restore

bash
ante backup                     # Create backup
ante backup list                # List backups
ante restore [file]             # Restore from backup

Database Operations

bash
ante db migrate                 # Run migrations
ante db shell                   # PostgreSQL shell
ante db optimize                # Optimize database
ante db info                    # Database info

SSL/HTTPS Configuration

bash
ante set-domain                 # Configure domains
ante ssl enable                 # Enable SSL/HTTPS
ante ssl status                 # Check certificate status

Updates

bash
ante update                     # Update ANTE ERP
ante update-cli                 # Update CLI tool

Cleanup

bash
ante uninstall                  # Uninstall ANTE
ante uninstall --keep-data      # Keep database volumes

For complete documentation:


Next Steps


Getting Help

Need assistance?


Congratulations! Your ANTE ERP instance is now running! 🎉


Last Updated: 2025-10-27

Released under the MIT License.