S3 Storage Server Configuration

If snapshot data will be stored in an external S3 storage provider, you must provide information about that environment using the S3StorageExternal property in MasterConfig.json.

S3 Client Configuration

{
  "S3StorageExternal": {
    "Provider": "RustFS",
    "Region": "us-east-1",
    "Server": "192.168.200.2",
    "Port": 9000,
    "UseSsl": true,
    "Path": "s3",
    "ConsolePort": 9001,
    "ConsoleUseSsl": true,
    "Bucket": "development",
    "Id": "admin",
    "Key": "p@ssw0rd"
  }
}

Configuration Properties

Property	Type	Description
Provider	String	The name of the product providing the S3 service (MinIO, RustFS, or SeaweedFS).
Region	String	If required, the name of the AWS region that the S3 server is emulating (e.g., us-east-1).
Server	String	The DNS name or TCP/IP address of the S3 server.
Port	Integer	The TCP/IP port number to use to access the S3 API.
UseSsl	Boolean	Is SSL required to access the server?
Path	String	The optional path to use between the S3 server URL and port, and the bucket name (required by some S3 servers, e.g., s3).
ConsolePort	Integer	If the S3 server exposes a browser UI, the TCP/IP port number where that UI is accessible.
ConsoleUseSsl	Boolean	If the S3 server exposes a browser UI, is SSL required to access the UI?
Bucket	String	The name of the S3 bucket to use.
Id	String	The optional username to use to authenticate with the S3 server.
Key	String	The optional password to use to authenticate with the S3 server.