NotAShelf/pinakes
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity Actions

chore: update wording for example config comments

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: If5d8db30bc8b877e462a1a2d2fa5f6206a6a6964
This commit is contained in:
raf 2026-02-10 09:49:57 +03:00
commit 4f24a47e1e
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 26 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

50
pinakes.example.toml
View file

@ -21,30 +21,30 @@ path = "pinakes.db"
# database = "pinakes" # database = "pinakes"
# username = "pinakes" # username = "pinakes"
# password = "your_secure_password_here" # password = "your_secure_password_here"
# # Maximum number of database connections in the pool ## Maximum number of database connections in the pool
# max_connections = 10 # max_connections = 10
# # Enable TLS/SSL for database connections ## Enable TLS/SSL for database connections
# # tls = { mode = "require", ca_cert = "/path/to/ca.pem" } # tls = { mode = "require", ca_cert = "/path/to/ca.pem" }
## Directory Configuration ## Directory Configuration
[directories] [directories]
# Root directories to scan for media files # Root directories to scan for media files
# Supports environment variable expansion: ${HOME}, $HOME # Supports environment variable expansion: ${HOME}, $HOME
# Paths can be absolute or relative to the working directory. # Paths can be absolute or relative to the working directory. Add more directories
# Add more directories as needed. # as needed.
roots = [ roots = [
"${HOME}/Music", "${HOME}/Music",
"${HOME}/Documents", "${HOME}/Documents",
"${HOME}/Videos", "${HOME}/Videos",
"${HOME}/Pictures", "${HOME}/Pictures",
# ... # ...
] ]
## File Scanning Configuration ## File Scanning Configuration
[scanning] [scanning]
# Watch directories for changes using filesystem events # Watch directories for changes using filesystem events
# When enabled, Pinakes will automatically detect new/modified/deleted files # When enabled, Pinakes will automatically detect new/modified/deleted files
# and update the catalog index.
# Default: true # Default: true
watch = true watch = true
@ -56,16 +56,16 @@ poll_interval_secs = 300
# File patterns to ignore during scanning (glob patterns) # File patterns to ignore during scanning (glob patterns)
# Default: Hidden files and common build/cache directories # Default: Hidden files and common build/cache directories
ignore_patterns = [ ignore_patterns = [
".*", # Hidden files (starting with .) ".*", # Hidden files (starting with .)
"node_modules", # JavaScript dependencies "node_modules", # JavaScript dependencies
"target", # Rust build artifacts "target", # Rust build artifacts
".git", # Git repository data ".git", # Git repository data
"__pycache__", # Python cache "__pycache__", # Python cache
"venv", # Python virtual environments "venv", # Python virtual environments
"*.tmp", # Temporary files "*.tmp", # Temporary files
"*.swp", # Vim swap files "*.swp", # Vim swap files
"Thumbs.db", # Windows thumbnail cache "Thumbs.db", # Windows thumbnail cache
".DS_Store", # macOS metadata ".DS_Store", # macOS metadata
] ]
## Server Configuration ## Server Configuration
@ -109,9 +109,9 @@ port = 3000
## Photo Management Configuration ## Photo Management Configuration
# These settings control CPU-intensive photo processing features # These settings control CPU-intensive photo processing features
[photos] [photos]
# Generate perceptual hashes for image duplicate detection # Generate perceptual hashes for image duplicate detection. Uses the
# Uses DCT (Discrete Cosine Transform) algorithm # DCT (Discrete Cosine Transform) algorithm, which is CPU-intensive, but
# CPU-intensive but enables finding visually similar images # enables finding visually similar images (mostly) accurately.
# Default: true # Default: true
generate_perceptual_hash = true generate_perceptual_hash = true
@ -273,6 +273,8 @@ enabled = false
# directory = "~/.local/share/pinakes/plugins" # directory = "~/.local/share/pinakes/plugins"
# Enable plugin system (experimental) # Enable plugin system (experimental)
# NOTE: The plugin system has not been finalized, and the API is subject to change.
# Please report any bugs, and expect breaking changes.
# Default: false # Default: false
# enabled = false # enabled = false