Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Parameters

Runtime parameters for crystalline are defined via environment variables prefixed with CRYSTALLINE_. The following table lists the available parameters and their default values:

ParameterDefaultDescription
CRYSTALLINE_DB_DIR/var/lib/crystalline/dbDirectory containing the configuration database
CRYSTALLINE_DATA_DIR/var/lib/crystalline/dataDirectory containing stored data and index contents
CRYSTALLINE_CACHE_DIR/var/lib/crystalline/cacheDirectory containing temporary files such as search results
CRYSTALLINE_EXTRA_DIR/var/lib/crystalline/extraDirectory containing additional configurations such as lookups or rulesets
CRYSTALLINE_HTTP_IP0.0.0.0IP address to bind the HTTP server to
CRYSTALLINE_HTTP_PORT8080Port number to bind the HTTP server to
CRYSTALLINE_BATCH_SIZE500Maximum number of documents a bucket will return at a time when searching
CRYSTALLINE_SCALE_FACTORCPU-based calculationDetermines how parallelisation happens across the program
CRYSTALLINE_PARALLEL_BUCKET_READERSCPU-based calculationNumber of buckets that can be read from in parallel
CRYSTALLINE_PARALLEL_BUCKET_WRITERSCPU-based calculationNumber of buckets that can be written to in parallel
CRYSTALLINE_WRITER_WORKER_THREADSCPU-based calculationNumber of threads each bucket writer will use
CRYSTALLINE_WRITER_WORKER_MEM16Amount of memory (in MiB) per bucket writer worker thread
CRYSTALLINE_INDEX_COMPRESSIONtrueEnable or disable index compression
CRYSTALLINE_IDLE_READER_TIMEOUT10Timeout in seconds after which an idle bucket reader is stopped
CRYSTALLINE_IDLE_WRITER_TIMEOUT60Timeout in seconds after which an idle bucket writer is stopped
CRYSTALLINE_COMMIT_INTERVAL5Time in seconds before forcing bucket writers to commit changes to disk
CRYSTALLINE_SEARCH_JOB_TTL7200 (2 hours)Time in seconds after which search results are deleted from cache
CRYSTALLINE_BOOTSTRAP_CONFIGNot setPath to a bootstrap JSON file to initialise application configuration