Getting Started
Welcome to Limitless Budget! This guide will help you get up and running quickly.
What is Limitless Budget?
Limitless Budget is a self-hosted, zero-based budgeting platform that gives you complete control over your finances. Unlike cloud-based budgeting apps, your data stays on your server, ensuring privacy and security.
Key features include:
- Zero-based budgeting methodology
- Fully customizable dashboard
- Multiple account management
- Transaction tracking and import
- Comprehensive reporting
- Budget sharing and collaboration
- Beautiful themes and customization
Prerequisites
Before you begin, make sure you have:
- Docker and Docker Compose installed on your server
- Basic terminal/command line knowledge (helpful but not required)
- A server with at least 1GB RAM and sufficient storage
- Port access (default port 3416, configurable)
Quick Start
The fastest way to get started is using Docker Compose:
- Clone or download the project
git clone [repository-url] limitless-budget cd limitless-budget - Create a `.env` file
cp .env.example .env # Edit .env with your values - Set required environment variables
At minimum, you need:
NEXTAUTH_SECRET=your-secret-key-here NEXTAUTH_URL=http://your-server-ip:3416 - Start the application
docker-compose up -d - Access the application
Open your browser and navigate to the URL you set in `NEXTAUTH_URL`
First Steps After Installation
1. Create Your Account
Navigate to the registration page and create your first user account. This will be your admin account.
2. Complete Initial Setup
The setup wizard will guide you through creating your first budget, setting your currency, and choosing your date format.
3. Add Your Accounts
Create accounts for checking, savings, credit cards, and other accounts you want to track.
4. Set Up Categories
Organize your budget with categories and category groups. These are where you'll assign your money.
5. Start Budgeting
Assign money to your categories and start tracking transactions. You're ready to begin your zero-based budgeting journey!
Next Steps
Now that you're up and running, check out these resources:
- Installation Guide - Detailed installation instructions
- Configuration - Configure your instance
- User Guide - Learn how to use all features
- FAQ - Common questions and answers
