meilisearch/config.toml

132 lines
4.3 KiB
TOML
Raw Normal View History

# This file shows the default configuration of Meilisearch.
# All variables are defined here https://docs.meilisearch.com/learn/configuration/instance_options.html#environment-variables
2022-09-20 00:16:28 +08:00
# db_path = "./data.ms"
# The destination where the database must be created.
2022-09-20 00:16:28 +08:00
# env = "development" # Possible values: [development, production]
# This environment variable must be set to `production` if you are running in production.
# More logs wiil be displayed if the server is running in development mode. Setting the master
# key is optional; hence no security on the updates routes. This
# is useful to debug when integrating the engine with another service.
2022-09-20 00:16:28 +08:00
# http_addr = "127.0.0.1:7700"
# The address on which the HTTP server will listen.
2022-09-21 16:55:16 +08:00
# master_key = "MASTER_KEY"
2022-09-20 00:16:28 +08:00
# Sets the instance's master key, automatically protecting all routes except GET /health.
# no_analytics = false
# Do not send analytics to Meilisearch.
2022-09-21 16:55:16 +08:00
# disable_auto_batching = false
2022-09-20 00:16:28 +08:00
# The engine will disable task auto-batching, and will sequencialy compute each task one by one.
2022-09-20 00:16:28 +08:00
### DUMP
2022-09-21 16:55:16 +08:00
# dumps_dir = "dumps/"
2022-09-20 00:16:28 +08:00
# Folder where dumps are created when the dump route is called.
2022-09-21 16:55:16 +08:00
# import_dump = "./path/to/my/file.dump"
2022-09-20 00:16:28 +08:00
# Import a dump from the specified path, must be a `.dump` file.
2022-09-21 16:55:16 +08:00
# ignore_missing_dump = false
# If the dump doesn't exist, load or create the database specified by `db_path` instead.
2022-09-21 16:55:16 +08:00
# ignore_dump_if_db_exists = false
2022-09-20 00:16:28 +08:00
# Ignore the dump if a database already exists, and load that database instead.
2022-09-20 00:16:28 +08:00
###
2022-09-21 16:55:16 +08:00
# log_level = "INFO" # Possible values: [ERROR, WARN, INFO, DEBUG, TRACE]
2022-09-20 00:16:28 +08:00
# Set the log level.
### INDEX
2022-09-21 16:55:16 +08:00
# max_index_size = "100 GiB"
2022-09-20 00:16:28 +08:00
# The maximum size, in bytes, of the main LMDB database directory.
2022-09-21 16:55:16 +08:00
# max_indexing_memory = "2 GiB"
# The maximum amount of memory the indexer will use. It defaults to 2/3 of the available
# memory. It is recommended to use something like 80%-90% of the available memory, no
# more.
#
# In case the engine is unable to retrieve the available memory the engine will try to use
# the memory it needs but without real limit, this can lead to Out-Of-Memory issues and it
# is recommended to specify the amount of memory to use.
#
# /!\ The default value is system dependant /!\
2022-09-21 16:55:16 +08:00
# max_indexing_threads = 4
# The maximum number of threads the indexer will use. If the number set is higher than the
# real number of cores available in the machine, it will use the maximum number of
# available cores.
#
# It defaults to half of the available threads.
2022-09-20 00:16:28 +08:00
###
2022-09-21 16:55:16 +08:00
# max_task_db_size = "100 GiB"
2022-09-20 00:16:28 +08:00
# The maximum size, in bytes, of the update LMDB database directory.
2022-09-21 16:55:16 +08:00
# http_payload_size_limit = 100000000
2022-09-20 00:16:28 +08:00
# The maximum size, in bytes, of accepted JSON payloads.
### SNAPSHOT
2022-09-21 16:55:16 +08:00
# schedule_snapshot = false
2022-09-20 00:16:28 +08:00
# Activate snapshot scheduling.
2022-09-21 16:55:16 +08:00
# snapshot_dir = "snapshots/"
# Defines the directory path where Meilisearch will create a snapshot each snapshot_interval_sec.
2022-09-20 00:16:28 +08:00
2022-09-21 16:55:16 +08:00
# snapshot_interval_sec = 86400
2022-09-20 00:16:28 +08:00
# Defines time interval, in seconds, between each snapshot creation.
2022-09-21 16:55:16 +08:00
# import_snapshot = false
2022-09-20 00:16:28 +08:00
# Defines the path of the snapshot file to import. This option will, by default, stop the
# process if a database already exist, or if no snapshot exists at the given path. If this
# option is not specified, no snapshot is imported.
2022-09-21 16:55:16 +08:00
# ignore_missing_snapshot = false
2022-09-20 00:16:28 +08:00
# The engine will ignore a missing snapshot and not return an error in such a case.
2022-09-21 16:55:16 +08:00
# ignore_snapshot_if_db_exists = false
2022-09-20 00:16:28 +08:00
# The engine will skip snapshot importation and not return an error in such a case.
###
### SSL
2022-09-21 16:55:16 +08:00
# ssl_auth_path = "./path/to/root"
2022-09-20 00:16:28 +08:00
# Enable client authentication, and accept certificates signed by those roots provided in CERTFILE.
2022-09-21 16:55:16 +08:00
# ssl_cert_path = "./path/to/CERTFILE"
# Read server certificates from CERTFILE. This should contain PEM-format certificates in
# the right order (the first certificate should certify KEYFILE, the last should be a root
2022-09-20 00:16:28 +08:00
# CA).
2022-09-21 16:55:16 +08:00
# ssl_key_path = "./path/to/private-key"
2022-09-20 00:16:28 +08:00
# Read the private key from KEYFILE. This should be an RSA private key or PKCS8-encoded
# private key, in PEM format.
2022-09-21 16:55:16 +08:00
# ssl_ocsp_path = "./path/to/OCSPFILE"
2022-09-20 00:16:28 +08:00
# Read DER-encoded OCSP response from OCSPFILE and staple to certificate. Optional.
2022-09-21 16:55:16 +08:00
# ssl_require_auth = false
2022-09-20 00:16:28 +08:00
# Send a fatal alert if the client does not complete client authentication.
2022-09-21 16:55:16 +08:00
# ssl_resumption = false
2022-09-20 00:16:28 +08:00
# SSL support session resumption.
2022-09-21 16:55:16 +08:00
# ssl_tickets = false
2022-09-20 00:16:28 +08:00
# SSL support tickets.
2022-09-20 00:16:28 +08:00
###