README.md

StreamFirebaseCDN

This package lets you use Firebase Storage as custom CDN in Stream Chat's attachments.

Installation

Swift Package Manager

You can add StreamFirebaseCDN to your project via Swift Package Manager by adding the following dependency to your Package.swift:

dependencies: [
    .package(
      url: "https://github.com/pzmudzinski/StreamFirebaseCDN.git",
      .upToNextMajor(from: "1.0.0")
    )
]

Usage

    import StreamFirebaseCDN

    static let chatClient: ChatClient = {
        var config = ChatClientConfig(apiKeyString: "something")
         config.customCDNClient = StreamFirebaseCDN()
        return ChatClient(config: config)
    }()

Configuration

Directory

By default CDN client will use default bucket and attachments directory for upload. You can configure it using Configuration and/or passing different instance of FirebaseStorage into constructor.

let customConfig = StreamFirebaseCDN.Configuration(folderName: "customFolder")
let customCDN = StreamFirebaseCDN(configuration: customConfig)

Changing default path for stored files

This will store files under {channelId}/{fileName} directory:

       let cdnClient = StreamFirebaseCDN(metadataFactory: { attachment in
            return nil
        }, idFactory: { attachment in
            if let localFileURL = attachment.uploadingState?.localFileURL {
                let cid = attachment.id.cid.rawValue
                return "\(cid)/\(localFileURL.lastPathComponent)"
            } else {
                return attachment.id.rawValue
            }
        })

Custom metadata

Each storage reference can have some metadata attached:

       let cdnClient = StreamFirebaseCDN(metadataFactory: { attachment in
            let metadata = StorageMetadata()
            metadata.customMetadata = [
                "cid": attachment.id.cid.rawValue,
                "messageId": attachment.id.messageId,
                "index": String(describing: attachment.id.index),
                "type": attachment.type.rawValue
            ]

            return metadata
        })

Storage rules

Remember to setup correct storage rules so client will be able to upload files directly into bucket. This is an example (allowing to have attachment with maximum size of 8MB):

rules_version = '2';
service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write: if false;
    }

    match /attachments/{images=**} {
        allow read: if true;
        allow write: if request.auth != null && request.resource.size < 8 * 1024 * 1024
    }
  }
}

License

StreamFirebaseCDN is available under the MIT license. See the LICENSE file for more info.