Skip to content

Commit 6a678d4

Browse files
add S3 instance options
1 parent 46f8ee1 commit 6a678d4

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed

learn/self_hosted/configure_meilisearch_at_launch.mdx

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,88 @@ Helps running Meilisearch in cluster environments. It does this by modifying tas
552552

553553
Falls back to previous settings indexer.
554554

555+
### S3 options
556+
557+
#### Bucket URL
558+
559+
**Environment variable**: `MEILI_S3_BUCKET_URL`<br />
560+
**CLI option**: `--s3-bucket-url`<br />
561+
**Default value**: `None`<br />
562+
563+
The URL for your S3 bucket. The URL must follow the format `https://s3.REGION.amazonaws.com`.
564+
565+
#### Bucket region
566+
567+
**Environment variable**: `MEILI_S3_BUCKET_REGION`<br />
568+
**CLI option**: `--s3-bucket-region`<br />
569+
**Default value**: `None`<br />
570+
571+
The region of your S3 bucket. Must be a valid AWS region, such as `us-east-1`.
572+
573+
#### Bucket name
574+
575+
**Environment variable**: `MEILI_S3_BUCKET_NAME`<br />
576+
**CLI option**: `--s3-bucket-name`<br />
577+
**Default value**: `None`<br />
578+
579+
The name of your S3 bucket.
580+
581+
#### Snapshot prefix
582+
583+
**Environment variable**: `MEILI_S3_SNAPSHOT_PREFIX`<br />
584+
**CLI option**: `--s3-snapshot-prefix`<br />
585+
**Default value**: `None`<br />
586+
587+
The path leading to the [snapshot directory](#snapshot-destination). Uses normal slashes.
588+
589+
#### Access key
590+
591+
**Environment variable**: `MEILI_S3_ACCESS_KEY`<br />
592+
**CLI option**: `--s3-access-key`<br />
593+
**Default value**: `None`<br />
594+
595+
Your S3 bucket's access key.
596+
597+
#### Secret key
598+
599+
**Environment variable**: `MEILI_S3_SECRET_KEY`<br />
600+
**CLI option**: `--s3-secret-key`<br />
601+
**Default value**: `None`<br />
602+
603+
Your S3 bucket's secret key.
604+
605+
#### Maximum parallel in-flight requests <NoticeTag type="experimental" label="experimental" />
606+
607+
**Environment variable**: `MEILI_EXPERIMENTAL_S3_MAX_IN_FLIGHT_PARTS`<br />
608+
**CLI option**: `--experimental-s3-max-in-flight-parts`<br />
609+
**Default value**: `10`<br />
610+
611+
The maximum number of in-flight multipart requests Meilisearch should send to S3 in parallel.
612+
613+
#### Compression level <NoticeTag type="experimental" label="experimental" />
614+
615+
**Environment variable**: `MEILI_EXPERIMENTAL_S3_COMPRESSION_LEVEL`<br />
616+
**CLI option**: `--experimental-s3-compression-level`<br />
617+
**Default value**: `0`<br />
618+
619+
The compression level to use for the snapshot tarball. Defaults to 0, no compression.
620+
621+
#### Signature duration <NoticeTag type="experimental" label="experimental" />
622+
623+
**Environment variable**: `MEILI_EXPERIMENTAL_S3_SIGNATURE_DURATION_SECONDS`<br />
624+
**CLI option**: `--experimental-s3-signature-duration-seconds`<br />
625+
**Default value**: `28800`<br />
626+
627+
The maximum duration processing a snapshot can take. Defaults to 8 hours.
628+
629+
#### Multipart section size <NoticeTag type="experimental" label="experimental" />
630+
631+
**Environment variable**: `MEILI_EXPERIMENTAL_S3_MULTIPART_PART_SIZE`<br />
632+
**CLI option**: `--experimental-s3-multipart-part-size`<br />
633+
**Default value**: `None`<br />
634+
635+
The size of each multipart section. Must be >10MiB and <8GiB. Defaults to 375MiB, which enables databases of up to 3.5TiB.
636+
555637
### SSL options
556638

557639
#### SSL authentication path

0 commit comments

Comments
 (0)