Limitless Budget
← Back to Documentation

Installation Guide

Step-by-step instructions for installing Limitless Budget using Docker.

Prerequisites

Before installing, ensure you have:

  • Docker (version 20.10 or later)
  • Docker Compose (version 2.0 or later)
  • At least 1GB RAM available
  • Sufficient disk space for the application and database

Verify Docker is installed:

docker --version docker-compose --version

Step 1: Download the Project

Clone the repository or download the source code:

git clone [repository-url] limitless-budget cd limitless-budget

Or download and extract the ZIP file to your desired location.

Step 2: Configure Environment Variables

Create a `.env` file in the project root:

cp .env.example .env nano .env  # or use your preferred editor

Set the following required variables:

Required Variables

  • NEXTAUTH_SECRET - Generate a secure random string:
    openssl rand -base64 32
  • NEXTAUTH_URL - Your server's URL (e.g., http://your-server-ip:3416 or https://your-domain.com)

Optional Variables

  • HOST_PORT - Port to expose (default: 3416)
  • DATA_PATH - Where to store database (default: ./data)

Step 3: Build and Start

Build and start the application:

docker-compose up -d

This will:

  • Build the Docker image
  • Create the data directory
  • Generate Prisma Client
  • Run database migrations
  • Start the application server

Step 4: Verify Installation

Check that the container is running:

docker-compose ps

View logs to ensure everything started correctly:

docker-compose logs -f app

You should see messages indicating successful database initialization and server startup.

Step 5: Access the Application

Open your web browser and navigate to the URL you set in NEXTAUTH_URL.

You should see the Limitless Budget landing page. Click "Get Started" or "Register" to create your first account.

Common Docker Commands

docker-compose up -d

Start the application in detached mode

docker-compose down

Stop the application

docker-compose logs -f app

View application logs

docker-compose restart

Restart the application

docker-compose up -d --build

Rebuild and restart after code changes

docker-compose down -v

Stop and remove volumes (⚠️ deletes database)

Next Steps

Once installed, check out: