Self-Hosted Installation | Regulus

Self-Hosted Installation Guide

Introduction

This guide provides detailed instructions for installing the self-hosted version of Regulus. By hosting Regulus on your own infrastructure, you gain greater control, enhanced customization, and seamless integration with your existing systems.

Prerequisites

  • Git: Ensure Git is installed on your machine. Use the following command to verify:
    git --version
  • Docker and Docker Compose: Install Docker and Docker Compose by following theofficial Docker guide.
  • PostgreSQL: Set up a PostgreSQL instance. Ensure you have the necessary credentials (username, password, database name).
  • Node.js: Install Node.js (version 14 or higher recommended).

System Requirements

  • Operating System: Ubuntu 20.04 or later, macOS 10.15 or later.
  • Processor: 4 CPU cores or more. ARM-based processors are also supported (e.g., Apple M1, M2)
  • Memory: 8 GB RAM (minimum), 16 GB recommended for production.
  • Storage: At least 10 GB of available hard drive space (preferably SSD for faster load times)

Installation Steps

  1. Clone the Repository:
    git clone https://github.com/getregulus/regulus.git
  2. Set Up Environment Variables: Create a .env file in the root directory and include:
    PORT=3000 
    NODE_ENV=production (default: development) 
    API_URL=http://localhost:3000 
    CORS_ORIGIN='' (default: no allowed origins for CORS) 
     
    DB_HOST=db 
    DB_PORT=5432 
    DB_USER=ChangeMe (default: postgres) 
    DB_PASS=ChangeMe (default: postgres) 
    DB_NAME=regulus 
     
    JWT_SECRET=ChangeMe 
    JWT_EXPIRATION=1h (default: 1h) 
    API_KEY_SECRET=ChangeMe
  3. Start the Application:
    docker-compose up -d
  4. Run Migrations: Apply database migrations:
    docker exec regulus-backend npx prisma migrate deploy
  5. Verify Installation: Access the application at:
    http://localhost:3000