Settings¶

crop_thumbnail_alignment

0

server

An number between 0 (left) to 1 (right)

enable_auto_indexing

True

server

Auto index

enabled_loggers

server

Loggers to enable. Available loggers: client,command,core,database,gui,network,plugin,search,server,misc

image_sizes

{‘big’: [300, 416], ‘medium’: [200, 276], ‘small’: [100, 136], ‘x2400’: [2400, 0], ‘x1600’: [1600, 0], ‘x1280’: [1280, 0], ‘x960’: [960, 0], ‘x768’: [768, 0]}

server

Image sizes, provided as key:value where value is a list [width, height]and key is one of big, medium, small, x2400, x1600, x1200, x960, x768

allow_beta_releases

True

server

Allow downloading beta releases

auto_cache_clean_size

2000

server

Maximum size in megabytes to which the cache folder will automatically get emptied when exceeded

auto_pages_clean_size

800

server

Maximum size in megabytes to which the pages cache folder will automatically get emptied when exceeded

auto_thumb_clean_size

500

server

Maximum size in megabytes to which the thumbnail cache folder will automatically get emptied when exceeded

backup_on_update

True

server

Create a backup before applying a new update

check_new_releases

True

server

Regularly check for updates

concurrent_image_tasks

10

server

Amount of image service tasks allowed to run at the same time (higher count does not necessarily mean faster generation)

debug

False

server

Run in debug mode

message_cache_time

3600

server

How many seconds to hold on to cached server messages (default: 1 hour)

pg_restore_tool_path

pg_restore

server

Path to pg_restore tool. On Windows the default path is ‘bin/win32/pg_restore.exe’. On Unix the default path is ‘pg_restore’ which assumes the tool is available in PATH

send_to_systemtrash

True

client

Send deleted files to the os recycle bin

trash_item_duration

168.0

server

How many hours an item can stay in the trash before getting deleted PERMANENTLY (default is 7 days)

unrar_tool_path

unrar

server

Path to unrar tool. On Windows the default path is ‘bin/win32/unrar.exe’. On Unix the default path is ‘unrar’ which assumes the tool is available in PATH

dialect

sqlite

server

Which SQL dialect to use between ‘sqlite’ and ‘postgresql’. Note that HPX will not transfer data from one dialect to another once chosen. It is therefore advised that you choose a dialect early and stick to it throughout. Only Postgres version 9.4 and up is supported

name

happypanda

server

Database name. This setting does not apply when the SQLite dialect is used

pool_size

15

server

The size of the pool to be maintained. This is the largest number of connections that will be kept persistently in the pool. This setting does not apply when the SQLite dialect is used

port

server

Database port. This setting does not apply when the SQLite dialect is used

sqlite_database_timeout

30

server

Amount of seconds to wait for the database to be writeable

disabled

server

A list of downloaders that shouldn’t be used, this is a list of download identifiers defined by the respective plugins

download_dir

downloads

client

Folder where to put successfully downloaded resources

options

{}

server

A mapping of setting:value, where setting is a fully qualified name of a config setting that should be overwritten For example: { ‘import.move_gallery’ : true, ‘import.move_dir’: ‘some/other/path’ } to move downloaded galleries to `some/other/path` during import

size

4

server

Size of concurrent downloads

skip_if_item_exists

True

client

Prevent adding a download item if it already exists in the database

auto_rate_on_favorite

True

client

Automatically set unrated galley rating to highest on favorite

delete_files

True

client

Delete gallery files on the filesystem when removing a gallery from the database

external_image_viewer_args

server

Command arguments to supply the image viewer executable

send_extracted_archive

False

server

Extract archive before sending path to external viewer

track_guest_read

True

server

Track gallery read status for guests

autostart_server

False

server

Start the server automatically on HPX GUI startup

send_to_tray_on_close

False

server

Put the application in the notification tray on close button

start_minimized_to_tray

False

server

Start the HPX GUI in a minimized to tray state

fail_on_move_error

True

client

Avoid adding a gallery to the database if the move failed

move_dir

client

Folder where to move successfully imported galleries

send_to_metadata_queue

True

client

Send item (if applicable) to metadata queue after it has been imported successfully

transparent_nested_folders

True

client

Treat a nested folder as being transparent

attributes

{‘__all__’: True}

client

A mapping of item attributes specifying which attributes metadata should be applied to. Set attribte:true to ‘turn on’ the attribute or attribute:false to ‘turn off’. use __all__:true to ‘turn on’ all attributes not specified or __all__:false to ‘turn them off’. The default value if this setting is empty is __all__:true

continue_fetching

True

server

If fetching from applied URLs fails, continue item lookup without URLs

only_if_never_fetched

True

server

Only fetch metadata for an item if it has never had a successful fetch before, else skip it. Note that this does not interfere with the auto metadata updater.

priority

server

A priority list of metadata fetchers, this is a list of metadata identifiers defined by the respective plugins. Note that the priority is just a hint and not a guarantee.

stop_after_first

True

server

Halt item metadata lookup after first successful lookup

delays_jitter

0.3

server

A randomization factor to add when delaying, should be a value between 0 and 1, inclusive

request_timeout

30

server

Upper limit of a request timeout in seconds

auto_install_plugin

False

server

Automatically install a discovered plugin

auto_install_plugin_release

True

server

Automatically download and install a new plugin update is found

check_plugin_release_interval

45

server

Interval in minutes between checking plugins for a new update, set 0 to only check once every startup

children

True

client

Also match on children

match_exact

False

client

Match terms exact instead of fuzzy

allowed_clients

0

server

Limit amount of clients allowed to be connected (0 means no limit)

elasticsearch_host

127.0.0.1

server

ElasticSearch host

elasticsearch_transport_port

7011

server

ElasticSearch transport port

enable_ssl

False

server

Enable SSL, valid values are true/false or “server”/”web” to only enable for the specific component

host

localhost

server

Specify which address the server should bind to

port

7007

server

Specify which port to start the server on

port_web

7008

server

Specify which port to start the webserver on

redis_host

127.0.0.1

server

Redis server host

redis_port

7009

server

Redis server port

server_cert

{‘certfile’: None, ‘keyfile’: None}

server

Path to a certificate and the corresponding private key. If keyfile is not set, the private key will be taken from certfile. Note that if SSL is enabled and no cert files are provided, a self-signed certificate will be created and used instead. The self-signed certificate can be found at data/certs/

session_span

0

server

Specify the amount of time (in minutes) a session can go unused before expiring or 0 for never

use_builtin_elasticsearch

True

server

Use the elasticsearch server bundled with HPX

web_cert

{‘certfile’: None, ‘keyfile’: None}

server

Same as server_cert. Values are inherited from server_cert If no values are provided and SSL is enabled for ‘web’ too

auto_add

True

server

Auto add new items to the database. Only auto-adding is supported at this time

enable

True

server

Enable monitoring folders for changes

network

server

A list of folders that resides on a network. There is no need to specify sub-folders, one root folder is enough

scan_on_startup

True

server

Scan for new items in watched folders on startup