Skip to content

docs: clarify dump/snapshot staging uses TMPDIR #3596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kerollmops merged 2 commits into from
Jun 15, 2026
Merged

docs: clarify dump/snapshot staging uses TMPDIR #3596

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d07fe13
docs: clarify dump/snapshot staging uses TMPDIR, not --dump-dir/--sna…
capJavert Jun 14, 2026
c2d153c
feat: adjust note
capJavert Jun 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions resources/self_hosting/configuration/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ Dumpless upgrade are not currently atomic. It is possible some processes fail an

Sets the directory where Meilisearch will create dump files.

<Note>
`--dump-dir` only controls where the final compressed `.dump` file is written. While creating a dump, Meilisearch first builds an uncompressed copy of your data in a temporary staging directory. This directory is located in the path indicated by the `TMPDIR` environment variable, defaulting to `/tmp` on most systems, and not in `--dump-dir`. On instances with a large database and a small `/tmp` partition, this can cause `No space left on device` errors even when `--dump-dir` points to a volume with plenty of free space. To avoid this, set `TMPDIR` to a directory on a volume with enough space for an uncompressed copy of your data before launching Meilisearch.
</Note>

[Learn more about creating dumps](/reference/api/management/create-dump).

### Import dump
Expand Down Expand Up @@ -293,6 +297,10 @@ When using the configuration file, it is also possible to explicitly pass a bool

Sets the directory where Meilisearch will store snapshots.

<Note>
`--snapshot-dir` only controls where the final `.snapshot` file is written. While creating a snapshot, Meilisearch first copies your entire database (the raw database files) into a temporary staging directory. This directory is located in the path indicated by the `TMPDIR` environment variable, defaulting to `/tmp` on most systems, and not in `--snapshot-dir`. On instances with a large database and a small `/tmp` partition, this can cause `No space left on device` errors even when `--snapshot-dir` points to a volume with plenty of free space. To avoid this, set `TMPDIR` to a directory on a volume with enough space for a full copy of your database before launching Meilisearch.
</Note>

### Uncompressed snapshots <NoticeTag type="experimental" label="experimental" />

**Environment variable**: `MEILI_EXPERIMENTAL_NO_SNAPSHOT_COMPACTION`<br />
Expand Down
Loading