OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse OpenIMSDK Guides
GUIDESOpenIMSDK Guides

OpenIMSDK guides organized by implementation stage, from product concepts and deployment to integration, extension, operations, and reliability.

Guides

Object Storage

Connect MinIO, OSS, COS, Kodo, or AWS S3 for file and media storage.

Copy

S3 object storage configuration

OpenIMSDK supports multiple S3-compatible object storage providers: MinIO, Alibaba Cloud OSS, Tencent Cloud COS, Qiniu KODO, and Amazon S3 (AWS).

  • Direct client uploads: The SDK uploads media files directly to the S3 bucket via pre-signed URLs, bypassing the API gateway to maximize server throughput and reduce network bottlenecks.
  • Access redirection & authorization: Requests routed through the API gateway validate caller permissions and issue HTTP redirects to the real object storage location.
  • Nginx reverse proxy: When routing API traffic through Nginx, configure proxy_set_header X-Request-Api $scheme://$host/api;. For complete reverse proxy examples, see Domain configuration.
  • Custom S3 providers: To integrate an unlisted S3-compatible storage backend, implement the server interface in OpenIM tools without modifying client SDKs. See s3.go interface definition.

Set the object.enable field in config/openim-rpc-third.yml to your chosen provider: minio, oss, cos, kodo, or aws (default: minio).

object:
  enable: minio

MinIO

  1. Set externalAddress in config/minio.yml to your application's public access URL. OpenIMServer does not need direct network reachability to this address; it uses it only to construct signature URLs for clients.
  2. For Nginx reverse proxy configuration with MinIO, see Domain configuration.
# Target bucket name for file storage
bucket: openim
# Access key ID for MinIO authentication
accessKeyID: root
# Secret access key for MinIO authentication
secretAccessKey: openIM123
# Session token (required only when using temporary STS credentials)
sessionToken:
# Internal service address used strictly for backend RPC calls (typically a private IP or container host)
internalAddress: localhost:10005
# Publicly accessible endpoint (HTTP/HTTPS domain or public IP) reachable by client applications
externalAddress: http://external_ip:10005
# Whether to enable public read permissions on the bucket. When set to true, the bucket is switched to public read. Setting to false does not automatically revert bucket ACL to private.
publicRead: false

Alibaba Cloud OSS

  1. Create a bucket in the Alibaba Cloud OSS Console.
  2. Generate API credentials in the Alibaba Cloud RAM Console.
  3. Refer to the Alibaba Cloud OSS Developer Guide for architecture details.
  4. Configure object.oss in config/openim-rpc-third.yml:
# OSS regional endpoint, e.g., http://oss-cn-hangzhou.aliyuncs.com
endpoint:
# Target bucket name
bucket:
# Publicly accessible URL for the bucket (such as a CDN accelerated domain)
bucketURL:
# Access key ID
accessKeyID:
# Access key secret
accessKeySecret:
# Session token (required only when using temporary STS credentials)
sessionToken:
# Public read mode. Recommended to keep false so the API can set Content-Type and download file names. If set to true, manage headers in the OSS console.
publicRead: false

Tencent Cloud COS

  1. Create a bucket in the Tencent Cloud COS Console.
  2. Generate API credentials in the Tencent Cloud CAM Console.
  3. Refer to the Tencent Cloud COS Documentation for detailed instructions.
  4. Configure object.cos in config/openim-rpc-third.yml:
# Bucket endpoint URL, e.g., https://temp-1252357374.cos.ap-chengdu.myqcloud.com
bucketURL:
# Secret ID for authentication
secretID:
# Secret key for authentication
secretKey:
# Session token (required only when using temporary STS credentials)
sessionToken:
# Public read mode. Recommended to keep false so download Content-Type and file names can be specified. If set to true, configure them in the COS console.
publicRead: false

Qiniu KODO

  1. Create a bucket in the Qiniu Cloud KODO Console.
  2. Generate API keys in the Qiniu Cloud Key Management Console.
  3. Refer to the Qiniu Cloud Security Documentation for credential setup.
  4. Configure object.kodo in config/openim-rpc-third.yml:
# Qiniu KODO regional endpoint, e.g., http://s3.cn-south-1.qiniucs.com
endpoint:
# Target bucket name
bucket: kodo-bucket-test
# Publicly accessible bucket domain, e.g., http://kodo-bucket-test-oetobfb.qiniudns.com
bucketURL:
# Access key ID
accessKeyID:
# Secret access key
accessKeySecret:
# Session token (required only when using temporary STS credentials)
sessionToken:
# Public read mode. Recommended to keep false to allow setting Content-Type and download file names.
publicRead: false

Amazon S3 (AWS)

  1. Review available endpoints in the AWS Regional Service Endpoints guide.
  2. Create an S3 bucket in the AWS S3 Console.
  3. Generate credentials in the AWS IAM Security Credentials Console.
  4. Refer to the Amazon S3 User Guide for configuration best practices.
  5. *Note: AWS S3 does not currently support dynamic thumbnail generation via URL parameters.*
  6. Configure object.aws in config/openim-rpc-third.yml:
# Target AWS region identifier, e.g., us-east-1
region:
# Target bucket name
bucket:
# Access key ID
accessKeyID:
# Secret access key
secretAccessKey:
# Session token (required only when using temporary IAM session credentials)
sessionToken:
# Public read mode. Setting to true is currently unsupported for AWS S3.
publicRead: false