meilisearch/config.toml

121 lines
5.4 KiB
TOML
Raw Permalink Normal View History

# This file shows the default configuration of Meilisearch.
2022-10-18 21:28:32 +08:00
# All variables are defined here: https://docs.meilisearch.com/learn/configuration/instance_options.html#environment-variables
db_path = "./data.ms"
2022-10-18 21:28:32 +08:00
# Designates the location where database files will be created and retrieved.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#database-path
2022-10-18 21:28:32 +08:00
env = "development"
# Configures the instance's environment. Value must be either `production` or `development`.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#environment
2022-10-18 21:28:32 +08:00
http_addr = "localhost:7700"
2022-09-20 00:16:28 +08:00
# The address on which the HTTP server will listen.
2022-10-18 21:28:32 +08:00
# master_key = "YOUR_MASTER_KEY_VALUE"
2022-09-20 00:16:28 +08:00
# Sets the instance's master key, automatically protecting all routes except GET /health.
2022-10-18 21:28:32 +08:00
# https://docs.meilisearch.com/learn/configuration/instance_options.html#master-key
2022-09-20 00:16:28 +08:00
2022-10-18 21:28:32 +08:00
# no_analytics = true
# 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.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#disable-analytics
2022-09-20 00:16:28 +08:00
2022-10-18 21:28:32 +08:00
http_payload_size_limit = "100 MB"
# Sets the maximum size of accepted payloads.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#payload-limit-size
2022-10-18 21:28:32 +08:00
log_level = "INFO"
# 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`
2022-10-18 21:28:32 +08:00
# https://docs.meilisearch.com/learn/configuration/instance_options.html#log-level
2022-10-18 21:28:32 +08:00
# max_indexing_memory = "2 GiB"
# Sets the maximum amount of RAM Meilisearch can use when indexing.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#max-indexing-memory
2022-10-18 21:28:32 +08:00
# max_indexing_threads = 4
# Sets the maximum number of threads Meilisearch can use during indexing.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#max-indexing-threads
2022-10-18 21:28:32 +08:00
#############
### DUMPS ###
#############
2022-09-20 00:16:28 +08:00
dump_dir = "dumps/"
2022-10-18 21:28:32 +08:00
# Sets the directory where Meilisearch will create dump files.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#dumps-destination
2022-09-20 00:16:28 +08:00
2022-10-18 21:28:32 +08:00
# import_dump = "./path/to/my/file.dump"
# Imports the dump file located at the specified path. Path must point to a .dump file.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#import-dump
2022-09-20 00:16:28 +08:00
2022-10-18 21:28:32 +08:00
ignore_missing_dump = false
# Prevents Meilisearch from throwing an error when `import_dump` does not point to a valid dump file.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ignore-missing-dump
2022-09-20 00:16:28 +08:00
2022-10-18 21:28:32 +08:00
ignore_dump_if_db_exists = false
# Prevents a Meilisearch instance with an existing database from throwing an error when using `import_dump`.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ignore-dump-if-db-exists
2022-09-20 00:16:28 +08:00
2022-10-18 21:28:32 +08:00
#################
### SNAPSHOTS ###
#################
2022-09-20 00:16:28 +08:00
schedule_snapshot = false
# 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.
2022-10-18 21:28:32 +08:00
# https://docs.meilisearch.com/learn/configuration/instance_options.html#schedule-snapshot-creation
2022-09-20 00:16:28 +08:00
snapshot_dir = "snapshots/"
2022-10-18 21:28:32 +08:00
# Sets the directory where Meilisearch will store snapshots.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#snapshot-destination
2022-09-20 00:16:28 +08:00
# import_snapshot = "./path/to/my/snapshot"
2022-10-18 21:28:32 +08:00
# Launches Meilisearch after importing a previously-generated snapshot at the given filepath.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#import-snapshot
2022-09-20 00:16:28 +08:00
ignore_missing_snapshot = false
2022-10-18 21:28:32 +08:00
# Prevents a Meilisearch instance from throwing an error when `import_snapshot` does not point to a valid snapshot file.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ignore-missing-snapshot
2022-09-20 00:16:28 +08:00
ignore_snapshot_if_db_exists = false
2022-10-18 21:28:32 +08:00
# Prevents a Meilisearch instance with an existing database from throwing an error when using `import_snapshot`.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ignore-snapshot-if-db-exists
2022-09-20 00:16:28 +08:00
2022-10-18 21:28:32 +08:00
###########
### SSL ###
###########
2022-09-21 16:55:16 +08:00
# ssl_auth_path = "./path/to/root"
2022-10-18 21:28:32 +08:00
# Enables client authentication in the specified path.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-authentication-path
2022-10-18 21:28:32 +08:00
# ssl_cert_path = "./path/to/certfile"
# Sets the server's SSL certificates.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-certificates-path
2022-09-21 16:55:16 +08:00
# ssl_key_path = "./path/to/private-key"
2022-10-18 21:28:32 +08:00
# Sets the server's SSL key files.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-key-path
2022-09-20 00:16:28 +08:00
2022-10-18 21:28:32 +08:00
# ssl_ocsp_path = "./path/to/ocsp-file"
# Sets the server's OCSP file.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-ocsp-path
ssl_require_auth = false
2022-10-18 21:28:32 +08:00
# Makes SSL authentication mandatory.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-require-auth
ssl_resumption = false
2022-10-18 21:28:32 +08:00
# Activates SSL session resumption.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-resumption
2022-10-18 21:28:32 +08:00
ssl_tickets = false
# Activates SSL tickets.
# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-tickets