MeiliSearch/config.toml

129 lines
5.7 KiB
TOML
Raw Normal View History

# This file shows the default configuration of Meilisearch.
2023-05-03 19:14:57 +02:00
# All variables are defined here: https://www.meilisearch.com/docs/learn/configuration/instance_options#environment-variables
2022-10-18 15:28:32 +02:00
# Designates the location where database files will be created and retrieved.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#database-path
db_path = "./data.ms"
2022-10-18 15:28:32 +02:00
# Configures the instance's environment. Value must be either `production` or `development`.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#environment
env = "development"
2022-09-19 18:16:28 +02:00
# The address on which the HTTP server will listen.
http_addr = "localhost:7700"
2022-09-19 18:16:28 +02:00
# Sets the instance's master key, automatically protecting all routes except GET /health.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#master-key
# master_key = "YOUR_MASTER_KEY_VALUE"
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Deactivates Meilisearch's built-in telemetry when provided.
# Meilisearch automatically collects data from all instances that do not opt out using this flag.
# All gathered data is used solely for the purpose of improving Meilisearch, and can be deleted at any time.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#disable-analytics
# no_analytics = true
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Sets the maximum size of accepted payloads.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#payload-limit-size
http_payload_size_limit = "100 MB"
2022-10-18 15:28:32 +02:00
# Defines how much detail should be present in Meilisearch's logs.
# Meilisearch currently supports six log levels, listed in order of increasing verbosity: `OFF`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#log-level
log_level = "INFO"
2022-10-18 15:28:32 +02:00
# Sets the maximum amount of RAM Meilisearch can use when indexing.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#max-indexing-memory
# max_indexing_memory = "2 GiB"
2022-10-18 15:28:32 +02:00
# Sets the maximum number of threads Meilisearch can use during indexing.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#max-indexing-threads
# max_indexing_threads = 4
2022-10-18 15:28:32 +02:00
#############
### DUMPS ###
#############
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Sets the directory where Meilisearch will create dump files.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#dump-directory
dump_dir = "dumps/"
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Imports the dump file located at the specified path. Path must point to a .dump file.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#import-dump
# import_dump = "./path/to/my/file.dump"
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Prevents Meilisearch from throwing an error when `import_dump` does not point to a valid dump file.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-missing-dump
ignore_missing_dump = false
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Prevents a Meilisearch instance with an existing database from throwing an error when using `import_dump`.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-dump-if-db-exists
ignore_dump_if_db_exists = false
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
#################
### SNAPSHOTS ###
#################
2022-09-19 18:16:28 +02:00
# Enables scheduled snapshots when true, disable when false (the default).
# If the value is given as an integer, then enables the scheduled snapshot with the passed value as the interval
# between each snapshot, in seconds.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#schedule-snapshot-creation
schedule_snapshot = false
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Sets the directory where Meilisearch will store snapshots.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#snapshot-destination
snapshot_dir = "snapshots/"
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Launches Meilisearch after importing a previously-generated snapshot at the given filepath.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#import-snapshot
# import_snapshot = "./path/to/my/snapshot"
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Prevents a Meilisearch instance from throwing an error when `import_snapshot` does not point to a valid snapshot file.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-missing-snapshot
ignore_missing_snapshot = false
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Prevents a Meilisearch instance with an existing database from throwing an error when using `import_snapshot`.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-snapshot-if-db-exists
ignore_snapshot_if_db_exists = false
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
###########
### SSL ###
###########
2022-10-18 15:28:32 +02:00
# Enables client authentication in the specified path.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-authentication-path
# ssl_auth_path = "./path/to/root"
2022-10-18 15:28:32 +02:00
# Sets the server's SSL certificates.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-certificates-path
# ssl_cert_path = "./path/to/certfile"
2022-10-18 15:28:32 +02:00
# Sets the server's SSL key files.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-key-path
# ssl_key_path = "./path/to/private-key"
2022-09-19 18:16:28 +02:00
2022-10-18 15:28:32 +02:00
# Sets the server's OCSP file.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-ocsp-path
# ssl_ocsp_path = "./path/to/ocsp-file"
2022-10-18 15:28:32 +02:00
# Makes SSL authentication mandatory.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-require-auth
ssl_require_auth = false
2022-10-18 15:28:32 +02:00
# Activates SSL session resumption.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-resumption
ssl_resumption = false
2022-10-18 15:28:32 +02:00
# Activates SSL tickets.
2023-05-03 19:14:57 +02:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-tickets
ssl_tickets = false
#############################
### Experimental features ###
#############################
# Experimental metrics feature. For more information, see: <https://github.com/meilisearch/meilisearch/discussions/3518>
# Enables the Prometheus metrics on the `GET /metrics` endpoint.
experimental_enable_metrics = false