2022-09-09 15:37:23 +08:00
|
|
|
# This file shows the default configuration of Meilisearch.
|
2023-05-04 01:14:57 +08:00
|
|
|
# All variables are defined here: https://www.meilisearch.com/docs/learn/configuration/instance_options#environment-variables
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-09-21 22:31:16 +08:00
|
|
|
db_path = "./data.ms"
|
2022-10-18 21:28:32 +08:00
|
|
|
# Designates the location where database files will be created and retrieved.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#database-path
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-10-18 21:28:32 +08:00
|
|
|
env = "development"
|
|
|
|
|
# Configures the instance's environment. Value must be either `production` or `development`.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#environment
|
2022-09-09 15:37:23 +08:00
|
|
|
|
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-09-09 15:37:23 +08:00
|
|
|
|
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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#payload-limit-size
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-10-18 21:28:32 +08:00
|
|
|
log_level = "INFO"
|
|
|
|
|
# Defines how much detail should be present in Meilisearch's logs.
|
2023-01-03 18:55:34 +08:00
|
|
|
# Meilisearch currently supports six log levels, listed in order of increasing verbosity: `OFF`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#log-level
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-10-18 21:28:32 +08:00
|
|
|
# max_indexing_memory = "2 GiB"
|
|
|
|
|
# Sets the maximum amount of RAM Meilisearch can use when indexing.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#max-indexing-memory
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-10-18 21:28:32 +08:00
|
|
|
# max_indexing_threads = 4
|
|
|
|
|
# Sets the maximum number of threads Meilisearch can use during indexing.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#max-indexing-threads
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-10-18 21:28:32 +08:00
|
|
|
#############
|
|
|
|
|
### DUMPS ###
|
|
|
|
|
#############
|
2022-09-20 00:16:28 +08:00
|
|
|
|
2022-12-01 22:40:44 +08:00
|
|
|
dump_dir = "dumps/"
|
2022-10-18 21:28:32 +08:00
|
|
|
# Sets the directory where Meilisearch will create dump files.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#dump-directory
|
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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#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`.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#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
|
|
|
|
2022-09-21 22:31:16 +08:00
|
|
|
schedule_snapshot = false
|
2022-12-28 01:17:29 +08: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-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#schedule-snapshot-creation
|
2022-09-20 00:16:28 +08:00
|
|
|
|
2022-09-21 22:31:16 +08:00
|
|
|
snapshot_dir = "snapshots/"
|
2022-10-18 21:28:32 +08:00
|
|
|
# Sets the directory where Meilisearch will store snapshots.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#snapshot-destination
|
2022-09-20 00:16:28 +08:00
|
|
|
|
2022-09-21 22:31:16 +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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#import-snapshot
|
2022-09-20 00:16:28 +08:00
|
|
|
|
2022-09-21 22:31:16 +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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-missing-snapshot
|
2022-09-20 00:16:28 +08:00
|
|
|
|
2022-09-21 22:31:16 +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`.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-snapshot-if-db-exists
|
2022-09-20 00:16:28 +08:00
|
|
|
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-10-18 21:28:32 +08:00
|
|
|
###########
|
|
|
|
|
### SSL ###
|
|
|
|
|
###########
|
2022-09-09 15:37:23 +08:00
|
|
|
|
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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-authentication-path
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-10-18 21:28:32 +08:00
|
|
|
# ssl_cert_path = "./path/to/certfile"
|
|
|
|
|
# Sets the server's SSL certificates.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-certificates-path
|
2022-09-09 15:37:23 +08:00
|
|
|
|
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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#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.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-ocsp-path
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-09-21 22:31:16 +08:00
|
|
|
ssl_require_auth = false
|
2022-10-18 21:28:32 +08:00
|
|
|
# Makes SSL authentication mandatory.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-require-auth
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-09-21 22:31:16 +08:00
|
|
|
ssl_resumption = false
|
2022-10-18 21:28:32 +08:00
|
|
|
# Activates SSL session resumption.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-resumption
|
2022-09-09 15:37:23 +08:00
|
|
|
|
2022-10-18 21:28:32 +08:00
|
|
|
ssl_tickets = false
|
|
|
|
|
# Activates SSL tickets.
|
2023-05-04 01:14:57 +08:00
|
|
|
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-tickets
|
2023-02-23 19:24:37 +08:00
|
|
|
|
|
|
|
|
#############################
|
|
|
|
|
### Experimental features ###
|
|
|
|
|
#############################
|
|
|
|
|
|
2023-02-28 00:14:06 +08:00
|
|
|
experimental_enable_metrics = false
|
2023-02-23 19:24:37 +08:00
|
|
|
# Experimental metrics feature. For more information, see: <https://github.com/meilisearch/meilisearch/discussions/3518>
|
|
|
|
|
# Enables the Prometheus metrics on the `GET /metrics` endpoint.
|
