Skip to content

File Storage

Configure how BrickTracker stores and manages instructions, images, and other files.

Storage Overview

BrickTracker manages several types of files:

  • Instruction PDFs: Downloaded from Rebrickable and Peeron
  • Set Images: Set photos from Rebrickable
  • Part Images: Part photos organized by color
  • Minifigure Images: Minifigure photos
  • Database Files: SQLite database

Folder Configuration

Default Folder Structure

Optional: Folder where to store the instructions, relative to '/app/' folder

bash
BK_INSTRUCTIONS_FOLDER=data/instructions

Optional: Folder where to store the sets images, relative to '/app/' folder

bash
BK_SETS_FOLDER=data/sets

Optional: Folder where to store the parts images, relative to '/app/' folder

bash
BK_PARTS_FOLDER=data/parts

Optional: Folder where to store the minifigures images, relative to '/app/' folder

bash
BK_MINIFIGURES_FOLDER=data/minifigures

Resulting Directory Structure

data/
├── instructions/          # PDF instruction files
│   ├── 10255-1.pdf
│   ├── 60266-1.pdf
│   └── ...
├── sets/                  # Set images
│   ├── 10255-1.jpg
│   ├── 60266-1.jpg
│   └── ...
├── parts/                 # Part images
│   ├── 3001-4.jpg         # Part 3001 in color 4
│   ├── 3002-1.jpg
│   └── ...
└── minifigures/           # Minifigure images
    ├── fig-001234.jpg
    └── ...

Allowed File Types:

Optional: A comma separated list of extensions allowed for uploading and displaying instruction files. You need to keep the dot (.) in the extension.

bash
BK_INSTRUCTIONS_ALLOWED_EXTENSIONS=.pdf

Image Management

Image Storage Options

Optional: Use remote image rather than the locally stored ones. Also prevents downloading any image when adding sets.

bash
BK_USE_REMOTE_IMAGES=false

Remote vs Local Images

Remote Images (BK_USE_REMOTE_IMAGES=true):

  • Disk space: No local storage required
  • Setup time: Instant - no downloads needed
  • Maintenance: Always up-to-date images
  • Internet required: No offline image viewing
  • External dependency: Relies on Rebrickable CDN

Local Images (BK_USE_REMOTE_IMAGES=false):

  • Offline access: Works without internet
  • Performance: No external requests for images
  • Reliability: Not affected by external service issues
  • Disk space: Can use several GB for large collections
  • Download time: Initial setup takes longer

This should genreally be set to false, unless you need to debug issues. Using remote images would query Rebrickable for all the images displayed on BrickTracker and not store any images locally. This could result in rate-limit or IP ban.

Released under the MIT License.