Configuration Overview

Configure BrickTracker for your specific setup, collection size, and workflow needs.

INFO

BrickTracker is designed to work well out-of-the-box with minimal configuration, but provides extensive customization options for advanced users. All settings are controlled through environment variables in a .env file.

Configuration Categories

Core Settings

Essential configuration including API keys, database settings, and basic application behavior.

Core Settings

Authentication

Optional password protection and session management for secure access to your collection.

Authentication

Pagination

Control how large datasets are displayed and navigated, with both server-side and client-side options.

Pagination

Storage

File storage settings for instructions, images, and database location.

Storage

UI Customization

Customize the interface appearance, behavior, and default settings.

UI Customization

Advanced Settings

Socket.IO configuration, external integrations, performance tuning, and developer options.

Advanced Settings

Complete Reference

Comprehensive documentation of all environment variables with defaults, examples, and troubleshooting.

Complete Reference

Configuration File Location

BrickTracker looks for configuration in these locations:

1. .env file in the data directory
2. Environment variables set in your system
3. Default values built into the application

Getting Started

1. Get the sample: curl -o .env https://gitea.baerentsen.space/FrederikBaerentsen/BrickTracker/raw/branch/master/.env.sample
2. Edit your settings: Open .env in your preferred editor
3. Start BrickTracker: docker compose up -d
4. Test your setup: Visit http://localhost:3333

Configuration Tips

• Start with minimal configuration and add settings as needed
• Enable authentication for shared environments

Important Notes

• Restart BrickTracker after changing configuration
• Some settings require specific formats (see individual pages)
• Backup your .env file before making major changes