From e32b82b961a7ee1ddef6bd7053649f8d7500b1e8 Mon Sep 17 00:00:00 2001 From: FrederikBaerentsen Date: Wed, 17 Dec 2025 10:26:10 -0500 Subject: [PATCH] feat(env): updated examples --- .env.sample | 84 +++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 59 insertions(+), 25 deletions(-) diff --git a/.env.sample b/.env.sample index 1eccfbf..97bd1f8 100644 --- a/.env.sample +++ b/.env.sample @@ -181,11 +181,19 @@ # Optional: Change the default order of minifigures. By default ordered by insertion order. # Useful column names for this option are: -# - "rebrickable_minifigures"."figure": minifigure ID (fig-xxxxx) -# - "rebrickable_minifigures"."number": minifigure ID as an integer (xxxxx) +# - "rebrickable_minifigures"."figure": minifigure ID (e.g., "fig-001234") +# - "rebrickable_minifigures"."number": minifigure ID as an integer (e.g., 1234) # - "rebrickable_minifigures"."name": minifigure name +# - "rebrickable_minifigures"."number_of_parts": number of parts in the minifigure +# - "bricktracker_minifigures"."quantity": quantity owned +# - "total_missing": number of missing parts (composite field) +# - "total_damaged": number of damaged parts (composite field) +# - "total_quantity": total quantity across all sets (composite field) +# - "total_sets": number of sets containing this minifigure (composite field) # Default: "rebrickable_minifigures"."name" ASC -# BK_MINIFIGURES_DEFAULT_ORDER="rebrickable_minifigures"."name" ASC +# Examples: +# BK_MINIFIGURES_DEFAULT_ORDER="rebrickable_minifigures"."number" DESC +# BK_MINIFIGURES_DEFAULT_ORDER="total_missing" DESC, "rebrickable_minifigures"."name" ASC # Optional: Folder where to store the minifigures images, relative to '/app/' folder # Default: data/minifigures @@ -199,13 +207,22 @@ # Optional: Change the default order of parts. By default ordered by insertion order. # Useful column names for this option are: -# - "bricktracker_parts"."part": part number -# - "bricktracker_parts"."spare": part is a spare part +# - "bricktracker_parts"."part": part number (e.g., "3001") +# - "bricktracker_parts"."spare": part is a spare part (0 or 1) +# - "bricktracker_parts"."quantity": quantity of this part +# - "bricktracker_parts"."missing": number of missing parts +# - "bricktracker_parts"."damaged": number of damaged parts # - "rebrickable_parts"."name": part name # - "rebrickable_parts"."color_name": part color name -# - "total_missing": number of missing parts +# - "total_missing": total missing across all sets (composite field) +# - "total_damaged": total damaged across all sets (composite field) +# - "total_quantity": total quantity across all sets (composite field) +# - "total_sets": number of sets containing this part (composite field) +# - "total_minifigures": number of minifigures with this part (composite field) # Default: "rebrickable_parts"."name" ASC, "rebrickable_parts"."color_name" ASC, "bricktracker_parts"."spare" ASC -# BK_PARTS_DEFAULT_ORDER="total_missing" DESC, "rebrickable_parts"."name"."name" ASC +# Examples: +# BK_PARTS_DEFAULT_ORDER="total_missing" DESC, "rebrickable_parts"."name" ASC +# BK_PARTS_DEFAULT_ORDER="rebrickable_parts"."color_name" ASC, "rebrickable_parts"."name" ASC # Optional: Folder where to store the parts images, relative to '/app/' folder # Default: data/parts @@ -267,9 +284,12 @@ # Optional: Change the default order of purchase locations. By default ordered by insertion order. # Useful column names for this option are: -# - "bricktracker_metadata_purchase_locations"."name" ASC: storage name +# - "bricktracker_metadata_purchase_locations"."name": purchase location name +# - "bricktracker_metadata_purchase_locations"."rowid": insertion order (special column) # Default: "bricktracker_metadata_purchase_locations"."name" ASC -# BK_PURCHASE_LOCATION_DEFAULT_ORDER="bricktracker_metadata_purchase_locations"."name" ASC +# Examples: +# BK_PURCHASE_LOCATION_DEFAULT_ORDER="bricktracker_metadata_purchase_locations"."name" DESC +# BK_PURCHASE_LOCATION_DEFAULT_ORDER="bricktracker_metadata_purchase_locations"."rowid" DESC # Optional: Shuffle the lists on the front page. # Default: false @@ -285,23 +305,23 @@ # Optional: URL of the image representing a missing image in Rebrickable # Default: https://rebrickable.com/static/img/nil.png -# BK_REBRICKABLE_IMAGE_NIL= +# BK_REBRICKABLE_IMAGE_NIL=https://rebrickable.com/static/img/nil.png # Optional: URL of the image representing a missing minifigure image in Rebrickable # Default: https://rebrickable.com/static/img/nil_mf.jpg -# BK_REBRICKABLE_IMAGE_NIL_MINIFIGURE= +# BK_REBRICKABLE_IMAGE_NIL_MINIFIGURE=https://rebrickable.com/static/img/nil_mf.jpg # Optional: Pattern of the link to Rebrickable for a minifigure. Will be passed to Python .format() # Default: https://rebrickable.com/minifigs/{figure} -# BK_REBRICKABLE_LINK_MINIFIGURE_PATTERN= +# BK_REBRICKABLE_LINK_MINIFIGURE_PATTERN=https://rebrickable.com/minifigs/{figure} # Optional: Pattern of the link to Rebrickable for a part. Will be passed to Python .format() # Default: https://rebrickable.com/parts/{part}/_/{color} -# BK_REBRICKABLE_LINK_PART_PATTERN= +# BK_REBRICKABLE_LINK_PART_PATTERN=https://rebrickable.com/parts/{part}/_/{color} # Optional: Pattern of the link to Rebrickable for instructions. Will be passed to Python .format() # Default: https://rebrickable.com/instructions/{path} -# BK_REBRICKABLE_LINK_INSTRUCTIONS_PATTERN= +# BK_REBRICKABLE_LINK_INSTRUCTIONS_PATTERN=https://rebrickable.com/instructions/{path} # Optional: User-Agent to use when querying Rebrickable and Peeron outside of the Rebrick python library # Default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 @@ -354,16 +374,22 @@ # Optional: Change the default order of sets. By default ordered by insertion order. # Useful column names for this option are: -# - "rebrickable_sets"."set": set number as a string -# - "rebrickable_sets"."number": the number part of set as an integer -# - "rebrickable_sets"."version": the version part of set as an integer +# - "rebrickable_sets"."set": set number as a string (e.g., "10255-1") +# - "rebrickable_sets"."number": the number part of set as text (e.g., "10255") +# - "rebrickable_sets"."version": the version part of set as an integer (e.g., 1) # - "rebrickable_sets"."name": set name # - "rebrickable_sets"."year": set release year # - "rebrickable_sets"."number_of_parts": set number of parts -# - "total_missing": number of missing parts -# - "total_minifigures": number of minifigures +# - "bricktracker_sets"."purchase_date": purchase date (as REAL/Julian day) +# - "bricktracker_sets"."purchase_price": purchase price +# - "total_missing": number of missing parts (composite field) +# - "total_damaged": number of damaged parts (composite field) +# - "total_minifigures": number of minifigures (composite field) # Default: "rebrickable_sets"."number" DESC, "rebrickable_sets"."version" ASC -# BK_SETS_DEFAULT_ORDER="rebrickable_sets"."year" ASC +# Examples: +# BK_SETS_DEFAULT_ORDER="rebrickable_sets"."year" DESC, "rebrickable_sets"."name" ASC +# BK_SETS_DEFAULT_ORDER="rebrickable_sets"."number_of_parts" DESC +# BK_SETS_DEFAULT_ORDER="total_missing" DESC, "rebrickable_sets"."year" ASC # Optional: Folder where to store the sets images, relative to '/app/' folder # Default: data/sets @@ -405,9 +431,12 @@ # Optional: Change the default order of storages. By default ordered by insertion order. # Useful column names for this option are: -# - "bricktracker_metadata_storages"."name" ASC: storage name +# - "bricktracker_metadata_storages"."name": storage name +# - "bricktracker_metadata_storages"."rowid": insertion order (special column) # Default: "bricktracker_metadata_storages"."name" ASC -# BK_STORAGE_DEFAULT_ORDER="bricktracker_metadata_storages"."name" ASC +# Examples: +# BK_STORAGE_DEFAULT_ORDER="bricktracker_metadata_storages"."name" DESC +# BK_STORAGE_DEFAULT_ORDER="bricktracker_metadata_storages"."rowid" DESC # Optional: URL to the themes.csv.gz on Rebrickable # Default: https://cdn.rebrickable.com/media/downloads/themes.csv.gz @@ -428,14 +457,19 @@ # Default: false # BK_USE_REMOTE_IMAGES=true -# Optional: Change the default order of sets. By default ordered by insertion order. +# Optional: Change the default order of wishlist sets. By default ordered by insertion order. # Useful column names for this option are: -# - "bricktracker_wishes"."set": set number as a string +# - "bricktracker_wishes"."set": set number as a string (e.g., "10255-1") # - "bricktracker_wishes"."name": set name # - "bricktracker_wishes"."year": set release year # - "bricktracker_wishes"."number_of_parts": set number of parts +# - "bricktracker_wishes"."theme_id": theme ID +# - "bricktracker_wishes"."rowid": insertion order (special column) # Default: "bricktracker_wishes"."rowid" DESC -# BK_WISHES_DEFAULT_ORDER="bricktracker_wishes"."set" DESC +# Examples: +# BK_WISHES_DEFAULT_ORDER="bricktracker_wishes"."year" DESC, "bricktracker_wishes"."name" ASC +# BK_WISHES_DEFAULT_ORDER="bricktracker_wishes"."number_of_parts" DESC +# BK_WISHES_DEFAULT_ORDER="bricktracker_wishes"."set" ASC # Optional: Show collection growth charts on the statistics page # Default: true