dnrops
/
meilisearch
mirror of https://github.com/meilisearch/meilisearch.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
meilisearch/config.toml

135 lines
6.0 KiB
TOML
Raw Normal View History

Add example config.toml with default values
2022-09-09 15:37:23 +08:00
# This file shows the default configuration of Meilisearch.
Update links of the docs
2023-05-04 01:14:57 +08:00
# All variables are defined here: https://www.meilisearch.com/docs/learn/configuration/instance_options#environment-variables
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Designates the location where database files will be created and retrieved.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#database-path
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
db_path = "./data.ms"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Configures the instance's environment. Value must be either `production` or `development`.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#environment
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
env = "development"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Apply PR review comments
2022-09-20 00:16:28 +08:00
# The address on which the HTTP server will listen.
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
http_addr = "localhost:7700"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Apply PR review comments
2022-09-20 00:16:28 +08:00
# Sets the instance's master key, automatically protecting all routes except GET /health.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#master-key
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# master_key = "YOUR_MASTER_KEY_VALUE"
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08: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.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#disable-analytics
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# no_analytics = true
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Sets the maximum size of accepted payloads.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#payload-limit-size
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
http_payload_size_limit = "100 MB"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Defines how much detail should be present in Meilisearch's logs.
Explicitly restrict log level options to those that are documented Fixes https://github.com/meilisearch/meilisearch/issues/3292
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`
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#log-level
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
log_level = "INFO"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Sets the maximum amount of RAM Meilisearch can use when indexing.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#max-indexing-memory
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# max_indexing_memory = "2 GiB"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Sets the maximum number of threads Meilisearch can use during indexing.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#max-indexing-threads
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# max_indexing_threads = 4
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
#############
### DUMPS ###
#############
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Sets the directory where Meilisearch will create dump files.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#dump-directory
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
dump_dir = "dumps/"
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Imports the dump file located at the specified path. Path must point to a .dump file.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#import-dump
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# import_dump = "./path/to/my/file.dump"
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Prevents Meilisearch from throwing an error when `import_dump` does not point to a valid dump file.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-missing-dump
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
ignore_missing_dump = false
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Prevents a Meilisearch instance with an existing database from throwing an error when using `import_dump`.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-dump-if-db-exists
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
ignore_dump_if_db_exists = false
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
#################
### SNAPSHOTS ###
#################
Apply PR review comments
2022-09-20 00:16:28 +08:00
Merge --schedule-snapshot and --snapshot-interval-sec options
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.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#schedule-snapshot-creation
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
schedule_snapshot = false
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Sets the directory where Meilisearch will store snapshots.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#snapshot-destination
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
snapshot_dir = "snapshots/"
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Launches Meilisearch after importing a previously-generated snapshot at the given filepath.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#import-snapshot
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# import_snapshot = "./path/to/my/snapshot"
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
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.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-missing-snapshot
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
ignore_missing_snapshot = false
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Prevents a Meilisearch instance with an existing database from throwing an error when using `import_snapshot`.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-snapshot-if-db-exists
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
ignore_snapshot_if_db_exists = false
Apply PR review comments
2022-09-20 00:16:28 +08:00
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
###########
### SSL ###
###########
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Enables client authentication in the specified path.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-authentication-path
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# ssl_auth_path = "./path/to/root"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Sets the server's SSL certificates.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-certificates-path
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# ssl_cert_path = "./path/to/certfile"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Sets the server's SSL key files.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-key-path
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# ssl_key_path = "./path/to/private-key"
Apply PR review comments
2022-09-20 00:16:28 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Sets the server's OCSP file.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-ocsp-path
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
# ssl_ocsp_path = "./path/to/ocsp-file"
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Makes SSL authentication mandatory.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-require-auth
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
ssl_require_auth = false
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Activates SSL session resumption.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-resumption
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
ssl_resumption = false
Add example config.toml with default values
2022-09-09 15:37:23 +08:00
Improve default config file
2022-10-18 21:28:32 +08:00
# Activates SSL tickets.
Update links of the docs
2023-05-04 01:14:57 +08:00
# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-tickets
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
ssl_tickets = false
update the config file to mention the experimental metrics feature
2023-02-23 19:24:37 +08:00
#############################
### 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.
Move comments above keys in config.toml The current style is very unusual, confusing and breaks compatibility with tools for parsing config files including comments. Everyone writes comments above the items to which they refer (maybe except pythonists), so let's stick to that.
2023-05-07 00:10:54 +08:00
experimental_enable_metrics = false
Add the option in the config file
2023-05-15 22:07:43 +08:00
# Experimental RAM reduction during indexing, do not use in production, see: <https://github.com/meilisearch/product/discussions/652>
Merge branch 'main' into tmp-release-v1.2.0
2023-06-06 00:36:28 +08:00
experimental_reduce_indexing_memory_usage = false
Add the default commented experimental batched tasks limit parameter to the config file
2023-12-12 17:59:00 +08:00
# Experimentally reduces the maximum number of tasks that will be processed at once, see: <https://github.com/orgs/meilisearch/discussions/713>
# experimental_max_number_of_batched_tasks = 100