BrickTracker

FrederikBaerentsen/BrickTracker

Fork 11

RSS Feed

v1.3.1 146f3706a5

Compare
BrickTracker Release 1.3.1 - Bug fixes Stable

FrederikBaerentsen released this 2025-12-20 21:47:26 +01:00 | 0 commits to master since this release
Warning

Breaking Changes

Version 1.3 introduces breaking changes to the default data folder structure and minifigures path.

Migration Required for Existing Installations:
- All user data now consolidated into single data/ folder for easier backup and Docker volume mapping
- Default minifigures folder changed from minifigs to minifigures
- Configuration file can now be stored in data/.env (recommended) or .env (backward compatible)
See Migration Guide for detailed upgrade instructions.
New Functionality
- Database Integrity Check and Cleanup
  - Added database integrity scanner to detect orphaned records and foreign key violations
  - New "Check Database Integrity" button in admin panel scans for issues
  - Detects orphaned sets, parts, and parts with missing set references
  - Warning prompts users to backup database before cleanup
  - Cleanup removes all orphaned records in one operation
  - Detailed scan results show affected records with counts and descriptions
- Database Optimization
  - Added "Optimize Database" button to re-create performance indexes
  - Safe to run after database imports or restores
  - Re-creates all indexes from migration #19 using CREATE INDEX IF NOT EXISTS
  - Runs ANALYZE to rebuild query statistics
  - Runs PRAGMA optimize for additional query plan optimization
  - Helpful after importing backup databases that may lack performance optimizations
Bug Fixes
- Fixed foreign key constraint errors during set imports: Resolved FOREIGN KEY constraint failed errors when importing sets with parts and minifigures
  - Fixed insertion order in bricktracker/part.py: Parent records (rebrickable_parts) now inserted before child records (bricktracker_parts)
  - Fixed insertion order in bricktracker/minifigure.py: Parent records (rebrickable_minifigures) now inserted before child records (bricktracker_minifigures)
  - Ensures foreign key references are valid when SQLite checks constraints
- Fixed set metadata updates: Owner, status, and tag checkboxes now properly persist changes on set details page
  - Fixed update_set_state() method to commit database transactions (was using deferred execution without commit)
  - All metadata updates (owner, status, tags, storage, purchase info) now work consistently
- Fixed nil image downloads: Placeholder images for parts and minifigures without images now download correctly
  - Removed early returns that prevented nil image downloads
  - Nil images now properly saved to configured folders (e.g., /app/data/parts/nil.jpg)
- Fixed error logging for missing files: File not found errors now show actual configured folder paths instead of just URL paths
  - Added detailed logging showing both file path and configured folder for easier debugging
- Fixed minifigure filters in client-side pagination mode: Owner and other filters now work correctly when server-side pagination is disabled
  - Aligned filter behavior with parts page (applies filters server-side, then loads filtered data for client-side search)
Update using latest tag:

If your compose.yaml contains image: gitea.baerentsen.space/frederikbaerentsen/bricktracker:latest, update with:
```
# Pull the new version
docker compose pull

# Restart the container with the new image
docker compose down
docker compose up -d
```
Update using version-tag:

If your compose.yaml specifies a version like image: gitea.baerentsen.space/frederikbaerentsen/bricktracker:1.3:

Edit your compose.yaml and change the version to 1.3.1:
```
image: gitea.baerentsen.space/frederikbaerentsen/bricktracker:1.3.1
```
```
# Pull the new version
docker compose pull

# Restart the container with the new image
docker compose down
docker compose up -d
```
Downloads
- Source Code (ZIP)
- Source Code (TAR.GZ)
v1.3 b1c32ea5aa

Compare
BrickTracker Release 1.3 - New Logo, Data Consolidation & New Features Stable

FrederikBaerentsen released this 2025-12-18 02:01:15 +01:00 | 12 commits to master since this release
Warning

Breaking Changes

Version 1.3 introduces breaking changes to the default data folder structure and minifigures path.

Migration Required for Existing Installations:
- All user data now consolidated into single data/ folder for easier backup and Docker volume mapping
- Default minifigures folder changed from minifigs to minifigures
- Configuration file can now be stored in data/.env (recommended) or .env (backward compatible)
See Migration Guide for detailed upgrade instructions.
Breaking Changes

Data Folder Consolidation

Version 1.3 consolidates all user data into a unified data/ folder structure:

Previous Structure:
```
/app/
├── app.db
├── .env
├── themes.csv
├── retired_sets.csv
└── static/
    ├── sets/
    ├── parts/
    ├── minifigs/
    └── instructions/
```
New Structure (v1.3):
```
/app/
└── data/
    ├── .env (optional, recommended)
    ├── app.db
    ├── themes.csv
    ├── retired_sets.csv
    ├── sets/
    ├── parts/
    ├── minifigures/
    └── instructions/
```
Benefits:
- Single Docker volume mount for all user data
- Simplified backup (one folder contains everything)
- Configuration persistence via data/.env
- Cleaner separation of code vs. data
Migration Options:
1. Migrate to new structure (recommended) - Single volume for all data including .env
2. Keep current setup (backward compatible) - Old paths continue to work
Configuration File Location
- New recommended location: data/.env (included in data volume, admin panel changes persist)
- Backward compatible: .env in root still works (requires separate volume mount)
- Priority: data/.env > .env (automatic detection)
Minifigures Folder Rename

Default minifigures folder changed from minifigs to minifigures for consistency.
- Users who relied on default (without explicit BK_MINIFIGURES_FOLDER config) need to either:
  1. Set BK_MINIFIGURES_FOLDER=minifigs to maintain existing behavior, or
  2. Rename existing minifigs folder to minifigures
- No impact if BK_MINIFIGURES_FOLDER already explicitly configured
New Features

Read the full changelog here

New Logo

Logo has changed from a generic brick to a BrickTracker custom logo. This was done to avoid attribution issues.

Live Settings Management

Complete admin panel overhaul for configuration management:

Live Settings (No Restart Required):
- Menu visibility toggles
- Table column display options
- Pagination settings
- Feature flags (consolidation, dark mode, etc.)
Static Settings (Restart Required):
- Authentication credentials
- API keys
- Database paths
- Server configuration
Advanced Features:
- Badge system showing value status (True/False, Set/Default/Unset)
- Changed indicator for modified values
- Lock detection for Docker environment variables
- Persistence warnings (shows if using non-persistent .env location)
All changes are saved to data/.env.

Dark Mode Support

Native Bootstrap 5.3 dark mode implementation:
- Toggle via BK_DARK_MODE environment variable
- Live-changeable in Admin > Live Settings
- Persistent across sessions
- System-wide consistent theming
Set Consolidation & Grouping

Duplicate set management:

Features:
- Automatic grouping of duplicate sets on main sets page
- Instance count badges (e.g., "3 copies")
- Expandable drawer to view individual set copies
- Full set cards for each instance with all badges and functionality
- Mixed status indicators (unchecked/partial/checked)
- Duplicate sets filter button
- Controlled via BK_SETS_CONSOLIDATION (default: false)
Smart Filtering:
- BK_SHOW_SETS_DUPLICATE_FILTER to show/hide filter button
- Works with both server-side and client-side pagination
Statistics Page

New Statistics page with complete collection analytics:

Financial Overview:
- Total collection cost
- Average price per set
- Price range analysis
- Investment tracking over time
Collection Metrics:
- Total sets count (with duplicates)
- Unique sets count
- Total parts inventory
- Total minifigures count
Analytics Dashboards:
- Theme distribution with clickable drill-down
- Storage location statistics with value calculations
- Purchase location analytics with spending patterns
- Year-based analytics (release years and purchase years)
- Problem tracking (missing/damaged parts)
Interactive Features:
- Clickable numbers filter to relevant sets
- Collection growth charts (line charts over time)
- Collapsible sections for organized viewing
- Configuration via BK_STATISTICS_SHOW_CHARTS and BK_STATISTICS_DEFAULT_EXPANDED
Access Control:
- BK_HIDE_STATISTICS to hide from menu
- Requires authentication if enabled
Pagination System

Individual pagination control per entity type:

Per-Entity Configuration:
- BK_SETS_SERVER_SIDE_PAGINATION
- BK_PARTS_SERVER_SIDE_PAGINATION
- BK_MINIFIGURES_SERVER_SIDE_PAGINATION
- BK_PROBLEMS_SERVER_SIDE_PAGINATION
Device-Specific Settings:
- Desktop pagination sizes
- Mobile pagination sizes
- Configurable per entity type
Features:
- Search, filtering, and sorting in both modes
- Mobile-friendly navigation
- Consistent experience across all pages
Spare Parts Control

Flexible spare parts management:
- BK_SKIP_SPARE_PARTS: Skip importing spare parts from Rebrickable (not saved to database)
- BK_HIDE_SPARE_PARTS: Hide spare parts from displays (must be in database)
- Independent or combined usage
- Live-changeable in admin panel
- Affects all parts displays
Parts Inventory System

Track verification progress during set walkthroughs:
- New "Checked" column in parts tables
- Checkboxes to mark parts as verified
- BK_HIDE_TABLE_CHECKED_PARTS to hide column
- Useful for building/sorting sets
Peeron Instructions Integration

Alternative instruction source when Rebrickable unavailable:

Features:
- Full image caching system
- Automatic thumbnail generation
- Optimized HTTP calls (download once, generate locally)
- Automatic cache cleanup after PDF generation
- Rate limiting to respect Peeron servers
BrickLink Set Links

Extended BrickLink integration:
- BrickLink badge links on set cards and details pages
- Appears alongside existing Rebrickable links
- BK_BRICKLINK_LINK_SET_PATTERN for URL customization
- Default: https://www.bricklink.com/v2/catalog/catalogitem.page?S={set_num}
- Controlled by existing BK_BRICKLINK_LINKS variable
Alphanumeric Set Numbers

Support for special edition and promotional sets:
- Database schema updated (INTEGER → TEXT)
- Supports sets with letters in numbers
- Examples: "McDR6US-1", "COMCON035-1", "EG00021-1"
Admin Page Customization

Configurable section expansion:
- BK_ADMIN_DEFAULT_EXPANDED_SECTIONS environment variable
- Comma-separated list of section names
- Valid sections: authentication, instructions, image, theme, retired, metadata, owner, purchase_location, status, storage, tag, database
- URL parameters take priority
- Database section expanded by default
Mobile & Network Improvements

WebSocket/Socket.IO Reliability:
- Polling-first strategy with automatic WebSocket upgrade
- 30-second connection timeout for slow mobile networks
- Ping/pong keepalive (30s timeout, 25s interval)
- Enhanced server-side connection logging
Bug Fixes & Enhancements

Instructions
- Fixed Rebrickable instruction downloads (removed cloudscraper dependency)
- Fixed "Open PDF" button links to use correct data route
- Corrected path resolution for data/instructions folder
- Fixed instruction listing to scan correct location
- Fixed Peeron PDF creation paths
Sets & Data Handling
- Fixed foreign key constraint errors when adding sets
- Atomic transaction handling for set downloads
- All-or-nothing database operations (prevents partial additions)
- Default image handling for sets without images (automatic nil.png fallback)
- Alphanumeric set number support
UI/UX
- Fixed dynamic sort icons across all pages
- Enhanced color dropdown (automatic duplicate merging)
- Improved DataTable integration with server-side pagination
- Disabled column header sorting when server-side pagination enabled
- Better search behavior (instant for client-side, Enter for server-side)
- Mobile-friendly pagination navigation
- Improved theme filtering (handles duplicate names)
- Fixed set number sorting (proper numeric sorting)
Configuration & Admin
- Fixed environment variable lock detection after saving
- Variables from data/.env or root .env shown as editable
- Docker environment variables remain properly locked
- Configuration persistence warnings in admin panel
Configuration Updates

New Environment Variables

Live Settings:
- BK_DARK_MODE - Enable dark mode theme (default: false)
- BK_SETS_CONSOLIDATION - Enable set grouping (default: false)
- BK_SKIP_SPARE_PARTS - Skip importing spare parts (default: false)
- BK_HIDE_SPARE_PARTS - Hide spare parts from display (default: false)
- BK_HIDE_TABLE_CHECKED_PARTS - Hide checked column (default: false)
- BK_SHOW_SETS_DUPLICATE_FILTER - Show duplicate filter button (default: true)
Pagination:
- BK_SETS_SERVER_SIDE_PAGINATION - Enable server-side pagination for sets
- BK_PARTS_SERVER_SIDE_PAGINATION - Enable server-side pagination for parts
- BK_MINIFIGURES_SERVER_SIDE_PAGINATION - Enable server-side pagination for minifigures
- BK_PROBLEMS_SERVER_SIDE_PAGINATION - Enable server-side pagination for problems
- Device-specific sizes: *_PAGINATION_SIZE_DESKTOP, *_PAGINATION_SIZE_MOBILE
Statistics:
- BK_HIDE_STATISTICS - Hide statistics menu item (default: false)
- BK_STATISTICS_SHOW_CHARTS - Show collection growth charts (default: true)
- BK_STATISTICS_DEFAULT_EXPANDED - Default section state (default: true)
Admin:
- BK_ADMIN_DEFAULT_EXPANDED_SECTIONS - Comma-separated list of sections to expand
BrickLink:
- BK_BRICKLINK_LINK_SET_PATTERN - BrickLink set URL pattern
Paths (Data Consolidation):
- All path variables now support data/ folder structure
- Backward compatible with old paths
Docker Updates

Compose File Changes:
- Simplified volume mapping (single data/ volume recommended)
- Updated default paths in example compose files
- Environment variable handling improved
Example Docker Compose (v1.3):
```
services:
  bricktracker:
    image: your-bricktracker-image:1.3
    volumes:
      - ./data:/app/data  # Single volume for all user data
    environment:
      - BK_REBRICKABLE_API_KEY=your_api_key
    ports:
      - "3333:3333"
```
Documentation Updates

BrickTracker.baerentsen.space is now the new location for documentation and guides. Check out What is BrickTracker? for a quick intro to BrickTracker (with screenshots) or Quick Start to get started.

New Documentation:
- Migration Guide - Comprehensive v1.3 upgrade instructions
- Overview - Quick overview of BrickTracker
- Complete Environment Variables Guide - All variables with examples
Improved Documentation:
- Better examples for database ordering options
- Docker deployment guides updated
- Quick start guide updated for v1.3
Upgrade Path

From 1.2.x to 1.3

Option 1: Migrate to New Structure (Recommended)
1. Backup your current installation
2. Follow the Migration Guide
3. Move data to new data/ folder structure
4. Update Docker compose volumes
5. Restart application
Option 2: Keep Current Structure (Backward Compatible)
1. Update to v1.3
2. Set explicit paths in .env for old locations
3. Application will work with existing structure
Both options preserve all data and settings.

Screenshots
Downloads
- Source Code (ZIP)
- Source Code (TAR.GZ)
v1.2.4 787a376553

Compare
BrickTracker v1.2.4 Release Notes Stable

FrederikBaerentsen released this 2025-09-16 10:52:45 +02:00 | 135 commits to master since this release
BrickTracker Release 1.2.4 - Enhanced BrickLink Integration

Warning

To use the new BrickLink color parameter in URLs, update your .env file:
BK_BRICKLINK_LINK_PART_PATTERN=https://www.bricklink.com/v2/catalog/catalogitem.page?P={part}&C={color}

New Features
- BrickLink Data Storage - Parts now store BrickLink color IDs, color names, and part numbers from Rebrickable API
- Enhanced BrickLink URLs - Part links now include accurate BrickLink part numbers and color parameters for precise catalog navigation
- Smart URL Fallback - Automatic fallback from BrickLink to Rebrickable data when BrickLink mappings are unavailable
- Admin Refresh Tracking - Set refresh page now detects and displays missing BrickLink data alongside existing checks
Database Enhancements
- Migration 0016 - Added bricklink_color_id and bricklink_color_name columns to rebrickable_parts table
- Migration 0017 - Added bricklink_part_num column to rebrickable_parts table
- Enhanced API Integration - Rebrickable API calls now automatically extract BrickLink mappings from external_ids.BrickLink data
- Improved Data Completeness - Admin tools now track and report missing BrickLink data for better collection management
UI/UX Enhancements
- BrickLink Issues Column - Single column showing total count of missing BrickLink data per set
- Streamlined Refresh Workflow - Existing refresh process now handles both Rebrickable and BrickLink data gaps
Affected Pages
- Part Details - BrickLink URLs now use accurate part numbers and include color parameters
- /admin/set/refresh - Enhanced with BrickLink data completeness tracking
- All Part Links - Improved accuracy for BrickLink catalog navigation across the application
Screenshots
Downloads
- BrickTracker_Bricklink.PNG
  44 KiB
  2025-09-16 10:51:56 +02:00
- Source Code (ZIP)
- Source Code (TAR.GZ)
v1.2.3 40b63fff6a

Compare
BrickTracker v1.2.3 Release Notes Stable

FrederikBaerentsen released this 2025-09-16 10:21:58 +02:00 | 139 commits to master since this release
BrickTracker Release - Enhanced Filtering & Search

New Features
- Owner filtering added to /minifigures page - filter minifigures by set owner
- Color filtering added to /parts page - filter parts by LEGO color with visual color indicators
- Filter state persistence - filters stay open when making selections for better user experience
UI/UX Enhancements
- Consistent interface design - parts and minifigures pages now use the same search/filter layout as sets
- Smart UI visibility - filter buttons automatically hide when not needed (e.g., when only one owner exists)
- Improved search functionality - enhanced search with better integration across filtered results
Database Enhancements
- Dynamic filtering queries - efficient SQL queries for owner and color-based filtering
- Optimized search performance - better search handling for filtered datasets
Affected Pages
- /parts - Added color filtering, enhanced search interface and sort options
- /minifigures - Added owner filtering, enhanced search interface and sort options
Screenshots
Downloads
- BrickTracker1.PNG
  39 KiB
  2025-09-16 10:08:08 +02:00
- BrickTracker2.PNG
  48 KiB
  2025-09-16 10:08:08 +02:00
- Source Code (ZIP)
- Source Code (TAR.GZ)
v1.2.0 fa3a321b9e

Compare
BrickTracker v1.2.0 Release Notes Stable

FrederikBaerentsen released this 2025-02-06 20:32:43 +01:00 | 154 commits to master since this release
BrickTracker 1.2.0

BrickTracker version 1.2.0 introduces better metadata support, improved part management, and enhanced UI controls. This release focuses on better organization through new storage features, purchase tracking, and ownership management.

How to Update

Assuming you are using Docker Compose to run BrickTracker, the update process depends on how you've configured your image tag.

Using latest tag

If your compose.yaml contains image: gitea.baerentsen.space/frederikbaerentsen/bricktracker::latest, update with:
```
# Pull the new version
docker compose pull

# Restart the container with the new image
docker compose down
docker compose up -d
```
Using version tag

If your compose.yaml specifies a version like image: gitea.baerentsen.space/frederikbaerentsen/bricktracker::1.1.1:
1. Edit your compose.yaml and change the version to 1.2.0
2. Run the following commands:
  # Pull the new version docker compose pull # Restart the container with the new image docker compose down docker compose up -d
After updating, you'll be prompted to upgrade the database as described in the Database Upgrade section below.

Database Upgrade Required

On first launch, you'll need to upgrade the database:
1. Click "Administration" when prompted
2. Click "Upgrade the database"
3. Download a backup of your database (strongly recommended)
4. Click "Upgrade the Database" to complete the process
Your database version should now be at version 15 (location may vary based on your settings):

Major Features

Important Notes

⚠️ The "Missing" feature has been renamed to "Problems" to accommodate both missing and damaged parts. Related environment variables have been updated accordingly.

Metadata System

It is now possible to add additional information to each set:
- Set ownership tracking
- Purchase information (date, price, location)
- Storage location management
- Custom tags support
Values can be changed on the admin page:

Enhanced Parts Management
- Color information and transparency details
- Part relationships (prints, base parts)
- Damaged parts tracking
- Improved part visualization
- Minifigure part count calculation
Show/hide missing and damaged parts can be controlled using environment variables.

Set Management
- New data refresh system for Rebrickable integration
- Enhanced wishlist management with set requesters
  - Track who requested each set using the Details button
  - Requesters can be selected from the available owners list
- Option to hide instructions
- Improved bulk operations
Note

In version 1.2.0, BrickTracker expands the data it stores from Rebrickable's API. Previously, it only saved essential information, but now it stores more data including part colors and relationships.
Sets from earlier versions need their data refreshed to access these new features. A new admin section shows which sets require updating.

Important:
- Updates use Rebrickable API calls
- Update sets gradually to avoid API rate limits
- After refresh, you'll see enhanced part details like colors and relationships
The refresh process populates all the new data fields, enabling features like color-coded part listings and print relationships in your set details.
UI Improvements
- Clear search functionality
- Enhanced form interactions and error handling
Environment Variables

Note

For a complete list of environment variables and their usage, see variables overview.

New Variables
- BK_HIDE_TABLE_MISSING_PARTS: Hide Missing column
- BK_HIDE_TABLE_DAMAGED_PARTS: Hide Damaged column
- BK_SHOW_GRID_SORT: Show sort options by default
- BK_SHOW_GRID_FILTERS: Show filter options by default
- BK_HIDE_ALL_STORAGES: Hide Storages menu
- BK_STORAGE_DEFAULT_ORDER: Storage ordering
- BK_PURCHASE_LOCATION_DEFAULT_ORDER: Purchase location ordering
- BK_PURCHASE_CURRENCY: Purchase price currency
- BK_PURCHASE_DATE_FORMAT: Purchase date format
Renamed Variables
- BK_HIDE_MISSING_PARTS → BK_HIDE_ALL_PROBLEMS_PARTS
See Changelog for more information.
Downloads
- Source Code (ZIP)
- Source Code (TAR.GZ)
1.2.0 a9bf5e03f8

Compare
BrickTracker v1.1.1 Release Notes Stable

FrederikBaerentsen released this 2025-01-27 19:35:36 +01:00 | 313 commits to master since this release
We are excited to announce version 1.1.1, which introduces a requested feature to download PDF instructions directly from Rebrickable. This update adds new functionality to both the instructions and set pages.

New Features
- PDF Instructions Download:
  - You can now easily download PDF instructions for your sets directly from Rebrickable.
  - A new Download instructions from Rebrickable button has been added to both the Instructions Page and the Set Page.
  - A list of available instructions will be displayed, and you can select which ones to download.
  - Please note that sets older than 20 years may not have available instructions for download.
Docker Update
- Docker Update:
  - When using Docker, ensure you are pulling the image with the 1.1.1 or latest tag for the new release.
Downloads
- Source Code (ZIP)
- Source Code (TAR.GZ)
v1.1.0 d2fa72dc63

Compare
BrickTracker v1.1.0 Release Notes Stable

FrederikBaerentsen released this 2025-01-24 19:29:33 +01:00 | 333 commits to master since this release
BrickTracker has made it to version 1.1.0, which is packed with improvements to deduplicate sets, enable custom checkboxes, and streamline database management. This update includes significant changes across the database, code, UI, and documentation to make the platform more robust and user-friendly.

Major Changes

⚠️ Important: After updating to the latest version, the application will display a splash screen indicating a database error and prompting an update. This behavior is expected and part of the upgrade process.
1. On the splash screen, click "Administration."
2. Next, click "Upgrade the Database."
3. Before proceeding, it is strongly recommended to download a backup of the database to ensure your data is safe in case of any migration issues.
4. Finally, press "Upgrade the Database" to complete the process.
Following these steps will ensure a smooth transition to the updated database structure.

Highlights

Database
- Set Deduplication:
  - Rebrickable sets are now unique in the database.
  - Multiple BrickTracker sets can now map to a single Rebrickable set.
- Upgrade/Migration Tool: A smoother process for forward-only database migrations with checks for outdated versions.
Docs
- Removed unnecessary <br> tags for better Gitea Markdown compatibility.
- Added a comprehensive DOCS.md for easier navigation and setup guidance.
- Documented database upgrades and checkbox management.
Code Updates

This release introduces tighter, more efficient code with enhancements like customizable checkboxes, unified update routes, and deduplicated set handling. We’ve also improved SQL practices, streamlined database migrations, and refined the admin views for better maintainability. Key workflows and record processes have been consolidated, while stricter Python function definitions ensure robustness.

UI Enhancements

Checkboxes
- Toggle visibility of checkboxes in the grid while keeping them accessible in set details.
- Full management support for custom checkboxes.
Set Grid
- New filters to search by selected or unselected checkboxes.
Wishlist
- Added a Rebrickable link badge for sets (thanks @matthew!).
Database
- Integrated migration tools into the UI for seamless upgrades.
Tables
- Fixed table searches to properly index content inside link pills.
This release represents a significant step forward in performance, flexibility, and usability. Thank you to @gregoo's amazing work!
Downloads
- Source Code (ZIP)
- Source Code (TAR.GZ)
v1.0.0 e2425a106a

Compare
BrickTracker v1.0.0 Release Notes Stable

FrederikBaerentsen released this 2025-01-19 09:47:15 +01:00 | 390 commits to master since this release
BrickTracker v1.0.0 Release Notes

Major Changes

BrickTracker has undergone a complete rewrite (thanks for gregoo) with significant improvements to both functionality and design. You can preview the new interface in the documentation.

⚠️ Important: This update includes changes to the application structure and configuration. Please follow the migration steps carefully to ensure your data remains intact.

Environment Configuration

You can configure environment variables in two ways:
1. In the compose.yaml file under the environment section
2. In a separate .env file referenced by env_file
Choose the method that best suits your deployment needs. All variables can be used in either location.

Migration Guide

Option 1: Local Installation (Git + Docker Build)

For users who installed via git clone and use build: . in their Docker configuration:
1. Update the repository:
  cd BrickTracker git pull
2. Restructure your static directories:
  mv static/instructions . mv static/sets . mv static/parts . mv static/minifigs .
3. Create data directory:
  mkdir data mv app.db data/
4. Replace your compose.yaml with:
  services: bricktracker: container_name: BrickTracker restart: unless-stopped build: . ports: - "3333:3333" volumes: - ./data:/data/ - ./instructions:/app/static/instructions/ - ./minifigures:/app/static/minifigures/ - ./parts:/app/static/parts/ - ./sets:/app/static/sets/ environment: BK_DATABASE_PATH: /data/app.db BK_RETIRED_SETS_PATH: /data/retired_sets.csv BK_THEMES_PATH: /data/themes.csv env_file: ".env"
  Note: You can move any environment variables from the .env file to the environment section above, or vice versa.
5. Update environment configuration:
  mv .env .env.backup mv .env.sample .env
  Then edit .env to include your API key and any desired customizations.
  
  Note: Make sure BK_RETIRED_SETS_PATH and BK_THEMES_PATH are set correctly to match your volume mappings.
6. Rebuild and restart:
  docker compose build docker compose up -d
Option 2: Pre-built Docker Image

For users who prefer using the pre-built Docker image:
1. Create data directory:
  mkdir data mv app.db data/
2. Update your compose.yaml:
  services: bricktracker: container_name: BrickTracker restart: unless-stopped image: gitea.baerentsen.space/frederikbaerentsen/bricktracker:1.0.0 ports: - "3333:3333" volumes: - ./parts:/app/static/parts - ./instructions:/app/static/instructions - ./minifigs:/app/static/minifigs - ./sets:/app/static/sets - ./data:/data/ env_file: ".env"
  Note: You can add an environment section to specify variables directly in the compose file instead of using .env.
3. Configure environment:
  Either download the sample configuration:
  wget -O .env https://gitea.baerentsen.space/FrederikBaerentsen/BrickTracker/raw/branch/master/.env.sample
  Or update your existing .env with these required fields:
  BK_REBRICKABLE_API_KEY=<your_api_key> BK_DOMAIN_NAME=http://localhost:3331 BK_DATABASE_PATH=/data/app.db BK_RETIRED_SETS_PATH=/data/retired_sets.csv BK_THEMES_PATH=/data/themes.csv
4. Deploy:
  docker compose pull docker compose up -d
Post-Installation Steps
1. Access BrickTracker at http://localhost:3333
2. Visit http://localhost:3333/admin
3. Update default images, themes, and retired sets using the provided buttons
Additional Notes
- The new .env file includes numerous customization options. Review it thoroughly to optimize your setup.
- Ensure all volume mappings in your compose.yaml are correct before starting the container.
- Back up your data before performing the migration.
- Environment variables can be configured either in the compose.yaml file or in the .env file, providing flexibility in how you manage your configuration.
Downloads
- Source Code (ZIP)
- Source Code (TAR.GZ)

8 Releases 8 Tags

BrickTracker Release 1.3.1 - Bug fixes Stable

New Functionality

Bug Fixes

Update using latest tag:

Update using version-tag:

BrickTracker Release 1.3 - New Logo, Data Consolidation & New Features Stable

Breaking Changes

Data Folder Consolidation

Configuration File Location

Minifigures Folder Rename

New Features

New Logo

Live Settings Management

Dark Mode Support

Set Consolidation & Grouping

Statistics Page

Pagination System

Spare Parts Control

Parts Inventory System

Peeron Instructions Integration

BrickLink Set Links

Alphanumeric Set Numbers

Admin Page Customization

Mobile & Network Improvements

Bug Fixes & Enhancements

Instructions

Sets & Data Handling

UI/UX

Configuration & Admin

Configuration Updates

New Environment Variables

Docker Updates

Documentation Updates

Upgrade Path

From 1.2.x to 1.3

Screenshots

BrickTracker v1.2.4 Release Notes Stable

BrickTracker Release 1.2.4 - Enhanced BrickLink Integration

New Features

Database Enhancements

UI/UX Enhancements

Affected Pages

Screenshots

BrickTracker v1.2.3 Release Notes Stable

BrickTracker Release - Enhanced Filtering & Search

New Features

UI/UX Enhancements

Database Enhancements

Affected Pages

Screenshots

BrickTracker v1.2.0 Release Notes Stable

BrickTracker 1.2.0

How to Update

Using latest tag

Using version tag

Database Upgrade Required

Major Features

Important Notes

Metadata System

Enhanced Parts Management

Set Management

UI Improvements

Environment Variables

New Variables

Renamed Variables

BrickTracker v1.1.1 Release Notes Stable

New Features

Docker Update

BrickTracker v1.1.0 Release Notes Stable

Major Changes

Highlights

Database

Docs

Code Updates

UI Enhancements

Checkboxes

Set Grid

Wishlist

Database

Update using `latest` tag: