# `ExOss`
[🔗](https://github.com/choice-form/ex_oss/blob/main/lib/ex_oss.ex#L1)

A unified S3-compatible object storage library with multi-CDN support.

Supports AWS S3, Qiniu S3, and any S3-compatible service (MinIO, DigitalOcean Spaces,
Cloudflare R2, etc.) with optional CDN integration (CloudFront, Qiniu CDN).

## Quick Start

    # 1. Define a storage module
    defmodule MyApp.Storage do
      use ExOss, otp_app: :my_app
    end

    # 2. Add configuration
    config :my_app, MyApp.Storage,
      provider: :aws,
      access_key_id: "your-access-key",
      secret_access_key: "your-secret-key",
      region: "us-east-1"

    # 3. Use it
    MyApp.Storage.upload_credential("bucket", "path/file.jpg", 3600)
    MyApp.Storage.authorize_download_url("bucket", "path/file.jpg", 3600)

## Multiple Clients

Define separate modules for different storage providers:

    defmodule MyApp.AWSStorage do
      use ExOss, otp_app: :my_app
    end

    defmodule MyApp.MinIOStorage do
      use ExOss, otp_app: :my_app
    end

    config :my_app, MyApp.AWSStorage, provider: :aws, access_key_id: "...", ...
    config :my_app, MyApp.MinIOStorage,
      provider: :custom,
      endpoint: "http://localhost:9000",
      bucket_addressing: :path,
      access_key_id: "minioadmin",
      secret_access_key: "minioadmin"

Or build clients programmatically:

    aws = ExOss.Client.new(provider: :aws, access_key_id: "...", ...)
    minio = ExOss.Client.new(provider: :custom, endpoint: "...", ...)

    ExOss.Runner.upload_credential(aws, "bucket", "key")
    ExOss.Runner.public_url(minio, "bucket", "key")

## CDN Configuration

    config :my_app, MyApp.Storage,
      provider: :aws,
      access_key_id: "...",
      secret_access_key: "...",
      cdn: [
        provider: :cloudfront,
        endpoint: "https://d123456789.cloudfront.net",
        aws_key_id: "K2XXXXXXXXXXXXX",
        aws_private_key: "-----BEGIN RSA PRIVATE KEY-----\n..."
      ]

---

*Consult [api-reference.md](api-reference.md) for complete listing*