@portal-hq/icloud-storage

Portal iCloud backup storage

The @portal-hq/icloud-storage package contains a storage adapter intended for use with the @portal-hq/core package.

This storage adapter allows end users to save backup MPC shares to their iCloud filesystem.

NOTE: This storage provider is only supported on iOS devices, so should not be used as your sole backup storage adapter unless you are explicitly releasing an iOS only app.

Basic usage

1. Install the package in your React Native project.

   yarn add @portal-hq/icloud-storage
   
   # OR #
   
   npm install --save @portal-hq/icloud-storage

2. Import the package into the component where you initialize the Portal class

   import Portal from '@portal-hq/core'
   import ICloudStorage from '@portal-hq/icloud-storage'

3. Register your storage adapter and initialize the Portal class

   const portal = new Portal({
     // ...your other config options
     backup: {
       icloud: new ICloudStorage(),
     },
   })

Setting up iCloud Backups in your iOS app

1. Open your project in XCode.
2. Navigate to Signing & Capabilities:

3. Click the + Button right below it, scroll down and select iCloud.

4. Under iCloud Services select Key-value storage.