保护您的项目
本教程将向您展示如何保护您的 Meilisearch 项目。
本教程将向您展示如何保护您的 Meilisearch 项目。您将了解如何管理您的主密钥以及如何使用 API 密钥安全地向 Meilisearch API 发送请求。
创建主密钥
主密钥是保护您的 Meilisearch 项目的第一步,也是最重要的一步。
在 Meilisearch Cloud 中创建主密钥
Meilisearch Cloud 会为每个项目自动生成一个主密钥。这意味着 Meilisearch Cloud 项目默认是安全的。
您可以通过访问项目概览查看您的主密钥。
在自托管实例中创建主密钥
要保护您的自托管实例,请使用 --master-key
命令行选项或 MEILI_MASTER_KEY
环境变量重新启动它。
主密钥必须至少为 16 字节长,并由有效的 UTF-8 字符组成。使用以下工具之一生成安全的主密钥:
Meilisearch 将照常启动。启动日志中应包含一条消息,告知您实例已受保护。
如果您提供了不安全的密钥,Meilisearch 将显示警告并建议您使用自动生成的替代密钥重新启动实例。
获取 API 密钥
当您的项目受保护时,Meilisearch 会自动生成两个 API 密钥:默认搜索 API 密钥
和 默认管理 API 密钥
。API 密钥是用于安全地与 Meilisearch API 通信的授权令牌。
在 Meilisearch Cloud 中获取 API 密钥
在您之前找到主密钥的同一部分查找您的 API 密钥。
在自托管实例中获取 API 密钥
使用您的主密钥查询 /keys
端点以查看实例中的所有 API 密钥。
仅使用主密钥管理 API 密钥。切勿使用主密钥执行搜索或其他常见操作。
Meilisearch 的响应将至少包含两个默认 API 密钥。
向 Meilisearch 发送安全的 API 请求
现在您拥有了 API 密钥,可以安全地查询 Meilisearch API。使用 Authorization
bearer token 头将 API 密钥添加到请求中。
使用 默认管理 API 密钥
执行敏感操作,例如创建新索引。
然后使用 默认搜索 API 密钥
在您刚创建的索引中执行搜索操作。
结论
您已通过配置主密钥成功保护了 Meilisearch。然后,您了解了如何通过在请求的授权头中添加 API 密钥来访问 Meilisearch API。