Configuration doc

This commit is contained in:
Gregoo 2025-02-04 17:04:09 +01:00
parent f0cec23da9
commit 2e995b615d
3 changed files with 12 additions and 6 deletions

View File

@ -60,6 +60,11 @@
# Legacy name: DOMAIN_NAME # Legacy name: DOMAIN_NAME
# BK_DOMAIN_NAME=http://localhost:3333 # BK_DOMAIN_NAME=http://localhost:3333
# Optional: Format of the timestamp for files on disk (instructions, themes)
# Check https://docs.python.org/3/library/time.html#time.strftime for format details
# Default: %d/%m/%Y, %H:%M:%S
# BK_FILE_DATETIME_FORMAT=%m/%d/%Y, %H:%M
# Optional: IP address the server will listen on. # Optional: IP address the server will listen on.
# Default: 0.0.0.0 # Default: 0.0.0.0
# BK_HOST=0.0.0.0 # BK_HOST=0.0.0.0
@ -91,11 +96,6 @@
# Default: false # Default: false
# BK_HIDE_ADMIN=true # BK_HIDE_ADMIN=true
# Optional: Hide the 'Problems' entry from the menu. Does not disable the route.
# Default: false
# Legacy name: BK_HIDE_MISSING_PARTS
# BK_HIDE_ALL_PROBLEMS_PARTS=true
# Optional: Hide the 'Instructions' entry from the menu. Does not disable the route. # Optional: Hide the 'Instructions' entry from the menu. Does not disable the route.
# Default: false # Default: false
# BK_HIDE_ALL_INSTRUCTIONS=true # BK_HIDE_ALL_INSTRUCTIONS=true
@ -108,6 +108,11 @@
# Default: false # Default: false
# BK_HIDE_ALL_PARTS=true # BK_HIDE_ALL_PARTS=true
# Optional: Hide the 'Problems' entry from the menu. Does not disable the route.
# Default: false
# Legacy name: BK_HIDE_MISSING_PARTS
# BK_HIDE_ALL_PROBLEMS_PARTS=true
# Optional: Hide the 'Sets' entry from the menu. Does not disable the route. # Optional: Hide the 'Sets' entry from the menu. Does not disable the route.
# Default: false # Default: false
# BK_HIDE_ALL_SETS=true # BK_HIDE_ALL_SETS=true

View File

@ -18,6 +18,7 @@
- Added: `BK_PURCHASE_LOCATION_DEFAULT_ORDER`, ordering of purchase locations - Added: `BK_PURCHASE_LOCATION_DEFAULT_ORDER`, ordering of purchase locations
- Added: `BK_PURCHASE_CURRENCY`, currency to display for purchase prices - Added: `BK_PURCHASE_CURRENCY`, currency to display for purchase prices
- Added: `BK_PURCHASE_DATE_FORMAT`, date format for purchase dates - Added: `BK_PURCHASE_DATE_FORMAT`, date format for purchase dates
- Documented: `BK_FILE_DATETIME_FORMAT`, date format for files on disk (instructions, theme)
### Code ### Code

View File

@ -28,9 +28,9 @@ CONFIG: Final[list[dict[str, Any]]] = [
{'n': 'HIDE_ALL_INSTRUCTIONS', 'c': bool}, {'n': 'HIDE_ALL_INSTRUCTIONS', 'c': bool},
{'n': 'HIDE_ALL_MINIFIGURES', 'c': bool}, {'n': 'HIDE_ALL_MINIFIGURES', 'c': bool},
{'n': 'HIDE_ALL_PARTS', 'c': bool}, {'n': 'HIDE_ALL_PARTS', 'c': bool},
{'n': 'HIDE_ALL_PROBLEMS_PARTS', 'e': 'BK_HIDE_MISSING_PARTS', 'c': bool},
{'n': 'HIDE_ALL_SETS', 'c': bool}, {'n': 'HIDE_ALL_SETS', 'c': bool},
{'n': 'HIDE_ALL_STORAGES', 'c': bool}, {'n': 'HIDE_ALL_STORAGES', 'c': bool},
{'n': 'HIDE_ALL_PROBLEMS_PARTS', 'e': 'BK_HIDE_MISSING_PARTS', 'c': bool},
{'n': 'HIDE_SET_INSTRUCTIONS', 'c': bool}, {'n': 'HIDE_SET_INSTRUCTIONS', 'c': bool},
{'n': 'HIDE_TABLE_DAMAGED_PARTS', 'c': bool}, {'n': 'HIDE_TABLE_DAMAGED_PARTS', 'c': bool},
{'n': 'HIDE_TABLE_MISSING_PARTS', 'c': bool}, {'n': 'HIDE_TABLE_MISSING_PARTS', 'c': bool},