Complete Environment Variables Reference
Comprehensive reference for all BrickTracker environment variables with defaults, examples, and use cases.
Note
This is the complete reference for BrickTracker version 1.3.0. For quick setup guides, see the Core Settings page.
Core Settings
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_REBRICKABLE_API_KEY | (required) | string | Rebrickable API access key for retrieving set data |
BK_HOST | 0.0.0.0 | IP | Server bind address |
BK_PORT | 3333 | number | Server port |
BK_DEBUG | false | boolean | Enable debugging mode |
BK_DATABASE_PATH | data/app.db | path | Database file location |
BK_TIMEZONE | Etc/UTC | string | Timezone for displaying datetimes |
Authentication
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_AUTHENTICATION_PASSWORD | (empty) | string | Admin password protection |
BK_AUTHENTICATION_KEY | (required if using auth) | string | Secret key for signing authentication tokens |
Images
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_USE_REMOTE_IMAGES | false | boolean | Use CDN vs local images |
BK_SETS_FOLDER | data/sets | path | Folder for storing set images |
BK_PARTS_FOLDER | data/parts | path | Folder for storing part images |
BK_MINIFIGURES_FOLDER | data/minifigures | path | Folder for storing minifigure images |
Sets Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_SETS_CONSOLIDATION | false | boolean | Group duplicate sets together |
BK_SETS_DEFAULT_ORDER | "rebrickable_sets"."number" DESC, "rebrickable_sets"."version" ASC | string | Default sort order for sets |
BK_SETS_SERVER_SIDE_PAGINATION | false | boolean | Enable server-side pagination for sets page |
BK_SETS_PAGINATION_SIZE_DESKTOP | 12 | number | Sets per page on desktop |
BK_SETS_PAGINATION_SIZE_MOBILE | 4 | number | Sets per page on mobile |
BK_SHOW_SETS_DUPLICATE_FILTER | true | boolean | Show duplicate filter button on sets page |
BK_SKIP_SPARE_PARTS | false | boolean | Skip importing spare parts from Rebrickable |
BK_HIDE_SPARE_PARTS | false | boolean | Hide spare parts from parts lists |
Parts Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_PARTS_DEFAULT_ORDER | "rebrickable_parts"."name" ASC, "rebrickable_parts"."color_name" ASC, "bricktracker_parts"."spare" ASC | string | Default sort order for parts |
BK_PARTS_SERVER_SIDE_PAGINATION | false | boolean | Enable server-side pagination for parts page |
BK_PARTS_PAGINATION_SIZE_DESKTOP | 10 | number | Parts per page on desktop |
BK_PARTS_PAGINATION_SIZE_MOBILE | 5 | number | Parts per page on mobile |
Minifigures Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_MINIFIGURES_DEFAULT_ORDER | "rebrickable_minifigures"."name" ASC | string | Default sort order for minifigures |
BK_MINIFIGURES_SERVER_SIDE_PAGINATION | false | boolean | Enable server-side pagination for minifigures page |
BK_MINIFIGURES_PAGINATION_SIZE_DESKTOP | 10 | number | Minifigures per page on desktop |
BK_MINIFIGURES_PAGINATION_SIZE_MOBILE | 5 | number | Minifigures per page on mobile |
Problems/Missing Parts Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_PROBLEMS_SERVER_SIDE_PAGINATION | false | boolean | Enable server-side pagination for problems page |
BK_PROBLEMS_PAGINATION_SIZE_DESKTOP | 10 | number | Problems per page on desktop |
BK_PROBLEMS_PAGINATION_SIZE_MOBILE | 5 | number | Problems per page on mobile |
Wishlist Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_WISHES_DEFAULT_ORDER | "bricktracker_wishes"."rowid" DESC | string | Default sort order for wishlist |
Storage Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_STORAGE_DEFAULT_ORDER | "bricktracker_metadata_storages"."name" ASC | string | Default sort order for storages |
Purchase Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_PURCHASE_DATE_FORMAT | %d/%m/%Y | string | Format for purchase dates |
BK_PURCHASE_CURRENCY | € | string | Currency symbol for purchase prices |
BK_PURCHASE_LOCATION_DEFAULT_ORDER | "bricktracker_metadata_purchase_locations"."name" ASC | string | Default sort order for purchase locations |
Instructions
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_INSTRUCTIONS_FOLDER | data/instructions | path | Folder for storing instruction files |
BK_INSTRUCTIONS_ALLOWED_EXTENSIONS | .pdf | string | Comma-separated list of allowed file extensions |
UI Visibility Settings
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_HIDE_ADD_SET | false | boolean | Hide 'Add' entry from menu |
BK_HIDE_ADD_BULK_SET | false | boolean | Hide 'Bulk add' entry from add page |
BK_HIDE_ADMIN | false | boolean | Hide 'Admin' entry from menu |
BK_HIDE_ALL_INSTRUCTIONS | false | boolean | Hide 'Instructions' entry from menu |
BK_HIDE_ALL_MINIFIGURES | false | boolean | Hide 'Minifigures' entry from menu |
BK_HIDE_ALL_PARTS | false | boolean | Hide 'Parts' entry from menu |
BK_HIDE_ALL_PROBLEMS_PARTS | false | boolean | Hide 'Problems' entry from menu |
BK_HIDE_ALL_SETS | false | boolean | Hide 'Sets' entry from menu |
BK_HIDE_ALL_STORAGES | false | boolean | Hide 'Storages' entry from menu |
BK_HIDE_STATISTICS | false | boolean | Hide 'Statistics' entry from menu |
BK_HIDE_WISHES | false | boolean | Hide 'Wishlist' entry from menu |
BK_HIDE_SET_INSTRUCTIONS | false | boolean | Hide 'Instructions' entry in set cards |
BK_HIDE_TABLE_DAMAGED_PARTS | false | boolean | Hide 'Damaged' column from parts table |
BK_HIDE_TABLE_MISSING_PARTS | false | boolean | Hide 'Missing' column from parts table |
BK_HIDE_TABLE_CHECKED_PARTS | false | boolean | Hide 'Checked' column from parts table |
UI Behavior Settings
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_ADMIN_DEFAULT_EXPANDED_SECTIONS | database | string | Comma-separated list of admin sections to expand by default |
BK_INDEPENDENT_ACCORDIONS | false | boolean | Make accordion items independent (multiple can be open) |
BK_SHOW_GRID_FILTERS | false | boolean | Display grid filters by default instead of collapsed |
BK_SHOW_GRID_SORT | false | boolean | Display grid sort by default instead of collapsed |
BK_RANDOM | false | boolean | Shuffle lists on the front page |
BK_DEFAULT_TABLE_PER_PAGE | 25 | number | Default items per page for big tables |
BK_DARK_MODE | false | boolean | Enable dark mode by default |
Statistics Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_STATISTICS_SHOW_CHARTS | true | boolean | Show collection growth charts on statistics page |
BK_STATISTICS_DEFAULT_EXPANDED | true | boolean | Default state of statistics page sections (expanded/collapsed) |
Rebrickable Integration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_REBRICKABLE_LINKS | false | boolean | Display Rebrickable links wherever applicable |
BK_REBRICKABLE_LINK_MINIFIGURE_PATTERN | https://rebrickable.com/minifigs/{figure} | string | URL pattern for minifigure links |
BK_REBRICKABLE_LINK_PART_PATTERN | https://rebrickable.com/parts/{part}/_/{color} | string | URL pattern for part links |
BK_REBRICKABLE_LINK_INSTRUCTIONS_PATTERN | https://rebrickable.com/instructions/{path} | string | URL pattern for instruction links |
BK_REBRICKABLE_IMAGE_NIL | https://rebrickable.com/static/img/nil.png | string | URL for missing part/set image placeholder |
BK_REBRICKABLE_IMAGE_NIL_MINIFIGURE | https://rebrickable.com/static/img/nil_mf.jpg | string | URL for missing minifigure image placeholder |
BK_REBRICKABLE_PAGE_SIZE | 100 | number | Items per API call when retrieving from Rebrickable |
BrickLink Integration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_BRICKLINK_LINKS | false | boolean | Display BrickLink links wherever applicable |
BK_BRICKLINK_LINK_PART_PATTERN | https://www.bricklink.com/v2/catalog/catalogitem.page?P={part}&C={color} | string | URL pattern for BrickLink part links |
BK_BRICKLINK_LINK_SET_PATTERN | https://www.bricklink.com/v2/catalog/catalogitem.page?S={set_num} | string | URL pattern for BrickLink set links |
Peeron Integration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_PEERON_DOWNLOAD_DELAY | 1000 | number | Delay in milliseconds between Peeron page downloads |
BK_PEERON_MIN_IMAGE_SIZE | 100 | number | Minimum image size (width/height) for valid Peeron instruction pages |
BK_PEERON_INSTRUCTION_PATTERN | http://peeron.com/scans/{set_number}-{version_number} | string | URL pattern for Peeron instruction pages |
BK_PEERON_THUMBNAIL_PATTERN | http://belay.peeron.com/thumbs/{set_number}-{version_number}/ | string | URL pattern for Peeron thumbnails |
BK_PEERON_SCAN_PATTERN | http://belay.peeron.com/scans/{set_number}-{version_number}/ | string | URL pattern for Peeron scans |
External Data Sources
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_RETIRED_SETS_FILE_URL | https://docs.google.com/spreadsheets/d/1rlYfEXtNKxUOZt2Mfv0H17DvK7bj6Pe0CuYwq6ay8WA/gviz/tq?tqx=out:csv&sheet=Sorted%20by%20Retirement%20Date | string | URL to unofficial retired sets list |
BK_RETIRED_SETS_PATH | data/retired_sets.csv | path | Path to retired sets CSV file |
BK_THEMES_FILE_URL | https://cdn.rebrickable.com/media/downloads/themes.csv.gz | string | URL to Rebrickable themes file |
BK_THEMES_PATH | data/themes.csv | path | Path to themes CSV file |
Database & File Formats
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_DATABASE_TIMESTAMP_FORMAT | %Y-%m-%d-%H-%M-%S | string | Timestamp format for database downloads |
BK_FILE_DATETIME_FORMAT | %d/%m/%Y, %H:%M:%S | string | Timestamp format for files on disk |
Network & Socket Configuration
| Variable | Default | Type | Purpose |
|---|---|---|---|
BK_DOMAIN_NAME | (empty) | string | CORS allow origin restriction for socket |
BK_SOCKET_NAMESPACE | bricksocket | string | Socket.IO socket namespace |
BK_SOCKET_PATH | /bricksocket/ | string | Socket.IO path |
BK_NO_THREADED_SOCKET | false | boolean | Disable threading on socket tasks |
BK_USER_AGENT | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 | string | User-Agent for external requests |
