在启动时配置 Meilisearch

当您自托管 Meilisearch 时，您可以使用命令行选项、环境变量或配置文件在启动时配置您的实例。

这些启动选项会影响您的整个 Meilisearch 实例，而不仅仅是单个索引。 有关影响单个索引内搜索的设置，请参阅索引设置。

启动 Meilisearch 实例时，传递命令行选项及其各自的值。

./meilisearch --db-path ./meilifiles --http-addr 'localhost:7700'

在前面的示例中，./meilisearch 是启动 Meilisearch 实例的命令，而 --db-path 和 --http-addr 是修改此实例行为的选项。

Meilisearch 还有许多命令行标志。 与命令行选项不同，标志不接受值。 如果给出了一个标志，它将被激活并更改 Meilisearch 的默认行为。

./meilisearch --no-analytics

上面的标志禁用 Meilisearch 实例的分析功能，并且不接受值。

命令行选项和命令行标志都优先于环境变量。 所有命令行选项和标志都以 -- 开头。

要使用环境变量配置 Meilisearch 实例，请在启动实例之前设置环境变量。如果您不确定如何操作，请阅读有关设置和列出环境变量的更多信息，或者改用命令行选项。

export MEILI_DB_PATH=./meilifiles
export MEILI_HTTP_ADDR=localhost:7700
./meilisearch

在前面的示例中，./meilisearch 是启动 Meilisearch 实例的命令，而 MEILI_DB_PATH 和 MEILI_HTTP_ADDR 是修改此实例行为的环境变量。

用于命令行标志的环境变量接受 n、no、f、false、off 和 0 作为 false。 缺少环境变量也将被视为 false。任何其他值都被视为 true。

环境变量始终与相应的命令行选项相同，但前缀为 MEILI_ 并且全部以大写字母书写。

Meilisearch 接受 .toml 格式的配置文件，作为命令行选项和环境变量的替代方案。 配置文件可以轻松共享和版本控制，并允许您定义多个选项。

当同时使用时，环境变量会覆盖配置文件，而命令行选项会覆盖环境变量。

您可以使用以下命令下载默认配置文件

curl https://raw.githubusercontent.com/meilisearch/meilisearch/latest/config.toml > config.toml

默认情况下，Meilisearch 将在工作目录中查找 config.toml 文件。 如果它存在，它将被用作配置文件。 您可以在启动 Meilisearch 时验证这一点

888b     d888          d8b 888 d8b                                            888
8888b   d8888          Y8P 888 Y8P                                            888
88888b.d88888              888                                                888
888Y88888P888  .d88b.  888 888 888 .d8888b   .d88b.   8888b.  888d888 .d8888b 88888b.
888 Y888P 888 d8P  Y8b 888 888 888 88K      d8P  Y8b     "88b 888P"  d88P"    888 "88b
888  Y8P  888 88888888 888 888 888 "Y8888b. 88888888 .d888888 888    888      888  888
888   "   888 Y8b.     888 888 888      X88 Y8b.     888  888 888    Y88b.    888  888
888       888  "Y8888  888 888 888  88888P'  "Y8888  "Y888888 888     "Y8888P 888  888

Config file path:       "./config.toml"

如果 Config file path 不是 "none"，则表示已成功找到配置文件并用于启动 Meilisearch。

您可以使用 MEILI_CONFIG_FILE_PATH 环境变量或 --config-file-path CLI 选项来覆盖配置文件的默认位置

./meilisearch --config-file-path="./config.toml"

您可以使用配置文件配置任何环境变量或 CLI 选项。 在配置文件中，选项必须以 蛇形命名法书写。 例如，--import-dump 将写为 import_dump。

import_dump = "./example.dump"

要在云托管实例中使用命令行选项配置 Meilisearch，请编辑其服务文件。 服务文件的默认位置是 /etc/systemd/system/meilisearch.service。

要在云托管实例中使用环境变量配置 Meilisearch，请修改 Meilisearch 的 env 文件。 其默认位置是 /var/opt/meilisearch/env。

编辑配置选项后，重新启动 Meilisearch 服务

systemctl restart meilisearch

环境变量: MEILI_CONFIG_FILE_PATH
CLI 选项: --config-file-path
默认值: ./config.toml
期望值: 文件路径

指定启动时要加载的配置文件的位置。

环境变量: MEILI_DB_PATH
CLI 选项: --db-path
默认值: "data.ms/"
期望值: 文件路径

指定将创建和检索数据库文件的位置。

环境变量: MEILI_ENV
CLI 选项: --env
默认值: development
期望值: production 或 development

配置实例的环境。 值必须是 production 或 development。

生产环境 (production):

• 设置至少 16 字节的主密钥是强制性的。 如果未提供主密钥或主密钥少于 16 字节，Meilisearch 将建议一个安全的自动生成的主密钥
• 搜索预览界面已禁用

开发环境 (development):

• 设置主密钥是可选的。 如果未提供主密钥或主密钥少于 16 字节，Meilisearch 将建议一个安全的自动生成的主密钥
• 搜索预览已启用

环境变量: MEILI_HTTP_ADDR
CLI 选项: --http-addr
默认值: "localhost:7700"
期望值: HTTP 地址和端口

设置 Meilisearch 将使用的 HTTP 地址和端口。

环境变量: MEILI_MASTER_KEY
CLI 选项: --master-key
默认值: None
期望值: 至少 16 字节的 UTF-8 字符串

设置实例的主密钥，自动保护除 GET /health 以外的所有路由。 这意味着您需要有效的 API 密钥才能访问所有其他端点。

当 --env 设置为 production 时，提供主密钥是强制性的。 如果未给出主密钥，或者主密钥少于 16 字节，Meilisearch 将抛出错误并拒绝启动。

当 --env 设置为 development 时，提供主密钥是可选的。 如果未给出主密钥，所有路由将不受保护并可公开访问。

如果您在 production 或 development 环境中未提供主密钥或主密钥少于 16 字节，Meilisearch 将建议一个安全的自动生成的主密钥，您可以在重新启动实例时使用。

了解有关 Meilisearch 安全密钥使用的更多信息。

环境变量: MEILI_NO_ANALYTICS
CLI 选项: --no-analytics

提供此选项后，将停用 Meilisearch 的内置遥测功能。

Meilisearch 会自动收集所有未选择使用此标志退出的实例的数据。 所有收集的数据仅用于改进 Meilisearch，并且可以随时删除。

阅读有关我们数据收集政策的更多信息，或查看我们收集的所有数据点的完整列表。

环境变量: MEILI_EXPERIMENTAL_DUMPLESS_UPGRADE
CLI 选项: --experimental-dumpless-upgrade
默认值: None
期望值: None

在您手动更新二进制文件后，将数据库迁移到新的 Meilisearch 版本。

了解有关将 Meilisearch 更新到新版本的更多信息.

环境变量: MEILI_DUMP_DIR
CLI 选项: --dump-dir
默认值: dumps/
期望值: 指向有效目录的文件路径

设置 Meilisearch 将在其中创建转储文件的目录。

了解有关创建转储的更多信息.

环境变量: MEILI_IMPORT_DUMP
CLI 选项: --import-dump
默认值: 无
期望值: 指向 .dump 文件的文件路径

导入位于指定路径的转储文件。 路径必须指向 .dump 文件。 如果数据库已存在，Meilisearch 将抛出错误并中止启动。

Meilisearch 仅在转储数据完全索引后才会启动。 这所需的时间取决于转储文件的大小。

环境变量: MEILI_IGNORE_MISSING_DUMP
CLI 选项: --ignore-missing-dump

防止在 --import-dump 未指向有效转储文件时 Meilisearch 抛出错误。 相反，Meilisearch 将正常启动，而不导入任何转储。

如果未定义 --import-dump，此选项将触发错误。

环境变量: MEILI_IGNORE_DUMP_IF_DB_EXISTS
CLI 选项: --ignore-dump-if-db-exists

防止具有现有数据库的 Meilisearch 实例在使用 --import-dump 时抛出错误。 相反，转储将被忽略，Meilisearch 将使用现有数据库启动。

如果未定义 --import-dump，此选项将触发错误。

环境变量: MEILI_LOG_LEVEL
CLI 选项: --log-level
默认值: 'INFO'
期望值: ERROR、WARN、INFO、DEBUG、TRACE 或 OFF 之一

定义 Meilisearch 日志中应存在的详细程度。

Meilisearch 当前支持五个日志级别，按详细程度递增的顺序列出

• 'ERROR'：仅记录指示 Meilisearch 未按预期运行的意外事件
• 'WARN'：记录所有意外事件，无论其严重程度如何
• 'INFO'：记录所有事件。 这是 --log-level 的默认值
• 'DEBUG'：记录所有事件，并包含有关 Meilisearch 内部流程的详细信息。 在诊断问题和调试时很有用
• 'TRACE'：记录所有事件，并包含有关 Meilisearch 内部流程的更多详细信息。 我们不建议使用此级别，因为它非常冗长。 在考虑 'TRACE' 之前，请先使用 'DEBUG'。
• 'OFF'：禁用日志记录

环境变量: MEILI_EXPERIMENTAL_LOGS_MODE
CLI 选项: --experimental-logs-mode
默认值: 'human'
期望值: human 或 json 之一

定义日志应输出人类可读的文本还是 JSON 数据。

环境变量: MEILI_MAX_INDEXING_MEMORY
CLI 选项: --max-indexing-memory
默认值: 可用 RAM 的 2/3
期望值: 整数 (104857600) 或人类可读的大小 ('100Mb')

设置 Meilisearch 在索引时可以使用的最大 RAM 量。 默认情况下，Meilisearch 使用不超过可用内存的三分之二。

该值必须以字节为单位给出，或者明确声明基本单位：107374182400、'107.7Gb' 或 '107374 Mb'。

Meilisearch 在索引期间可能会超出确切的 RAM 限制。 在大多数环境和机器中，这应该是可以忽略不计的量，对稳定性和性能几乎没有影响。

环境变量: MEILI_EXPERIMENTAL_REDUCE_INDEXING_MEMORY_USAGE
CLI 选项: --experimental-reduce-indexing-memory-usage
默认值: None

启用 MDB_WRITEMAP，这是一个 LMDB 选项。 激活此选项可能会减少某些 UNIX 和类 UNIX 设置中的 RAM 使用量。 但是，它也可能对写入速度和整体性能产生负面影响。

环境变量: MEILI_MAX_INDEXING_THREADS
CLI 选项: --max-indexing-threads
默认值: 可用线程数的一半
期望值: 整数

设置 Meilisearch 在索引期间可以使用的最大线程数。 默认情况下，索引器避免使用超过机器总处理单元一半的资源。 这确保 Meilisearch 始终可以执行搜索，即使在您更新索引时也是如此。

如果 --max-indexing-threads 高于机器中可用的实际核心数，Meilisearch 将使用最大可用核心数。

在单核机器中，Meilisearch 别无选择，只能使用可用于索引的唯一核心。 这可能会导致索引期间的搜索体验下降。

环境变量: MEILI_HTTP_PAYLOAD_SIZE_LIMIT
CLI 选项: --http-payload-size-limit
默认值: 104857600 (~100MB)
期望值: 整数

设置接受的有效负载的最大大小。 值必须以字节为单位给出，或者明确声明基本单位。 例如，默认值可以写为 107374182400、'107.7Gb' 或 '107374 Mb'。

环境变量: MEILI_EXPERIMENTAL_SEARCH_QUEUE_SIZE
CLI 选项: --experimental-search-queue-size
默认值: 1000
期望值: 整数

配置最大并发搜索请求数。 默认情况下，Meilisearch 在任何给定时刻最多排队 1000 个搜索请求。 此限制的存在是为了防止 Meilisearch 消耗无限量的 RAM。

环境变量: MEILI_EXPERIMENTAL_EMBEDDING_CACHE_ENTRIES
CLI 选项: --experimental-embedding-cache-entries
默认值: 0
期望值: 整数

设置搜索查询嵌入缓存的大小。 默认情况下，Meilisearch 为每个新搜索查询生成一个嵌入。 当此选项设置为大于 0 的整数时，如果 Meilisearch 最近执行了相同的查询，则会返回先前生成的嵌入。

最近最少使用的条目首先被逐出。 具有相同配置的嵌入器共享相同的缓存，即使它们在不同的索引中声明也是如此。

环境变量: MEILI_SCHEDULE_SNAPSHOT
CLI 选项: --schedule-snapshot
默认值: 如果不存在则禁用，如果存在但没有值则为 86400
期望值: None 或整数

激活计划快照。 默认情况下禁用快照。

可以使用没有值的 --schedule-snapshot。 如果在启动实例时存在 --schedule-snapshot 但未分配值，Meilisearch 每 24 小时拍摄一次新快照。

为了更好地控制快照计划，请传递一个整数，表示每个快照之间的时间间隔（以秒为单位）。 当 --schedule-snapshot=3600 时，Meilisearch 每小时拍摄一次新快照。

了解有关快照的更多信息.

环境变量: MEILI_SNAPSHOT_DIR
CLI 选项: --snapshot-dir
默认值: snapshots/
期望值: 指向有效目录的文件路径

设置 Meilisearch 将存储快照的目录。

环境变量: MEILI_IMPORT_SNAPSHOT
CLI 选项: --import-snapshot
默认值: None
期望值: 指向快照文件的文件路径

在导入给定文件路径中先前生成的快照后启动 Meilisearch。

如果出现以下情况，此命令将抛出错误

• 数据库已存在
• 在指定路径中找不到有效的快照

此行为可以使用 --ignore-snapshot-if-db-exists 和 --ignore-missing-snapshot 选项分别进行修改。

环境变量: MEILI_IGNORE_MISSING_SNAPSHOT
CLI 选项: --ignore-missing-snapshot

防止在 --import-snapshot 未指向有效快照文件时 Meilisearch 实例抛出错误。

如果未定义 --import-snapshot，此命令将抛出错误。

环境变量: MEILI_IGNORE_SNAPSHOT_IF_DB_EXISTS
CLI 选项: --ignore-snapshot-if-db-exists

防止具有现有数据库的 Meilisearch 实例在使用 --import-snapshot 时抛出错误。 相反，快照将被忽略，Meilisearch 将使用现有数据库启动。

如果未定义 --import-snapshot，此命令将抛出错误。

环境变量: MEILI_TASK_WEBHOOK_URL
CLI 选项: --task-webhook-url
默认值: None
期望值: URL 字符串

每当 Meilisearch 完成处理任务或批量任务时，通知配置的 URL。 Meilisearch 使用给定的 URL，保留任何指定的查询参数。

Webhook 有效负载包含 ndjson 中已完成任务的列表。 有关更多信息，请查阅专门的任务 webhook 指南。

环境变量: MEILI_TASK_WEBHOOK_AUTHORIZATION_HEADER
CLI 选项: --task-webhook-authorization-header
默认值: None
期望值: 身份验证令牌字符串

在通知 webhook URL 时，在授权标头中包含身份验证令牌。

环境变量: MEILI_EXPERIMENTAL_MAX_NUMBER_OF_BATCHED_TASKS
CLI 选项: --experimental-max-number-of-batched-tasks
默认值: None
期望值: 整数

限制 Meilisearch 在单个批处理中执行的任务数。 可能会提高处理大量资源密集型任务队列的系统的稳定性。

环境变量: MEILI_EXPERIMENTAL_REPLICATION_PARAMETERS
CLI 选项: --experimental-replication-parameters
默认值: None

通过以下三种方式修改任务处理，帮助在集群环境中运行 Meilisearch

• 任务自动删除已禁用
• 允许您通过向 API 请求添加自定义 TaskId 标头来手动设置任务 uids
• 允许您通过在请求中指定 DryRun: true 标头来干式注册任务

环境变量: MEILI_SSL_AUTH_PATH
CLI 选项: --ssl-auth-path
默认值: None
期望值: 文件路径

在指定路径中启用客户端身份验证。

环境变量: MEILI_SSL_CERT_PATH
CLI 选项: --ssl-cert-path
默认值: None
期望值: 指向有效 SSL 证书的文件路径

设置服务器的 SSL 证书。

值必须是 PEM 格式证书的路径。 第一个证书应证明由 --ssl-key-path 提供的 KEYFILE。 最后一个证书应该是根 CA。

环境变量: MEILI_SSL_KEY_PATH
CLI 选项: --ssl-key-path
默认值: None
期望值: 指向有效 SSL 密钥文件的文件路径

设置服务器的 SSL 密钥文件。

值必须是 RSA 私钥或 PKCS8 编码的私钥的路径，两者均为 PEM 格式。

环境变量: MEILI_SSL_OCSP_PATH
CLI 选项: --ssl-ocsp-path
默认值: None
期望值: 指向有效 OCSP 证书的文件路径

设置服务器的 OCSP 文件。 可选

从 OCSPFILE 读取 DER 编码的 OCSP 响应并将其装订到证书。

环境变量: MEILI_SSL_REQUIRE_AUTH
CLI 选项: --ssl-require-auth
默认值: None

使 SSL 身份验证成为强制性的。

如果客户端未完成客户端身份验证，则发送致命警报。

环境变量: MEILI_SSL_RESUMPTION
CLI 选项: --ssl-resumption
默认值: None

激活 SSL 会话恢复。

环境变量: MEILI_SSL_TICKETS
CLI 选项: --ssl-tickets
默认值: None

激活 SSL 票证。