Skip to content

Commit 89e6f69

Browse files
Merge #2122
2122: Clean up master key description in instance options page r=maryamsulemani97 a=dichotommy Improve organization of information concerning master key instance option Co-authored-by: Tommy Melvin <tommy@meilisearch.com>
2 parents b887fcc + 92a08cc commit 89e6f69

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

learn/configuration/instance_options.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -194,17 +194,13 @@ Sets the HTTP address and port Meilisearch will use.
194194
**Default value**: `None`
195195
**Expected value**: an alphanumeric string
196196

197-
Sets the instance's master key, automatically protecting all routes except [`GET /health`](/reference/api/health.md). This means you will need an API key to access endpoints such as `POST /search` and `GET /documents`. [You can read more about security keys in Meilisearch in our dedicated guide.](/learn/security/master_api_keys.md)
197+
Sets the instance's master key, automatically protecting all routes except [`GET /health`](/reference/api/health.md). This means you will need a valid API key to access all other endpoints.
198198

199-
::: note
200-
You must supply an alphanumeric string when using this option.
201-
:::
202-
203-
Providing a master key is mandatory when `--env` is set to `production`. If none is given, Meilisearch will throw an error and refuse to launch.
199+
When `--env` is set to `production`, providing a master key is mandatory. If none is given, Meilisearch will throw an error and refuse to launch.
204200

205-
If no master key is provided in a `development` environment, all routes will be unprotected and publicly accessible.
201+
When `--env` is set to `development`, providing a master key is optional. If none is given, all routes will be unprotected and publicly accessible.
206202

207-
[Learn more about Meilisearch's use of security keys.](/learn/security/master_api_keys.md)
203+
[Read more about master and API keys in our dedicated guide.](/learn/security/master_api_keys.md)
208204

209205
### Disable auto-batching
210206

0 commit comments

Comments
 (0)