Confirm that you meet the minimum requirements. (Prerequisites)

Install the necessary dependencies. (Installing Package Dependencies)

Set up your app permissions. (Configuring Permissions)

Authenticate with Ditto Server and then start syncing offline. (Integrating and Initializing Sync)

Configure your project’s Info.plist file to ensure the necessary permissions for Bluetooth Low Energy (LE) and local network services are included. (Ensuring Privacy Compliance)

If enabling the Data Protection entitlement, allow access after your end users have unlocked their device for the first time after a system restart. (Setting Protection Entitlement)

From Xcode, add a new Custom iOS Target Properties entry:

1. From the left navigator area, click your project.
2. In the editor that appears, click Info tab.
3. Right-click any row in the list, and then select Add Row from the menu.

From your project’s Info.plistfile, add the following key-value pairs, which display as dismissable prompts to your end users explaining why the app requires certain permissions.

Key: NSBluetoothAlwaysUsageDescription
Type: String
Value: Uses Bluetooth to connect and sync with nearby devices
Key: NSBluetoothPeripheralUsageDescription
Type: String
Value: Uses Bluetooth to connect and sync with nearby devices
Key: NSLocalNetworkUsageDescription
Type: String
Value: Uses WiFi to connect and sync with nearby devices
Key: NSBonjourServices
Type: Array
Value: Item0: "_http-alt._tcp." (String)

If your end users prefer a language other than English, replace each default string assigned to Value with their language equivalents.

From Xcode, ensure your app continues to sync while it runs in the background, as well as when the end-user device is locked by enabling Bluetooth Background Modes:

1. From the left navigator area, click your project.
2. Click Signing & Capabilities.
3. Click + Capability and then, from the modal that appears, search and select Background Modes.
4. From TARGETS, select your app from the list.
5. From Background Modes, click to select the following:

• Uses Bluetooth LE accessories
• Acts as a Bluetooth LE accessory

From the top-most scope of your app’s codebase, add the following to set up authentication and start syncing offline.

Replace YOUR_APP_ID and YOUR_PLAYGROUND_TOKEN with your access credentials available from the portal.

ditto = Ditto(
  identity: DittoIdentity.onlinePlayground(
    appID: "REPLACE_ME_WITH_YOUR_APP_ID",
    token: "REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN",
    enableDittoCloudSync: false, // This is required to be set to false to use the correct URLs
    customAuthURL: URL(string: "REPLACE_ME_WITH_YOUR_AUTH_URL")
  )
)

ditto.updateTransportConfig { transportConfig in
  // Set the Ditto Websocket URL
  transportConfig.connect.webSocketURLs.insert("wss://REPLACE_ME_WITH_YOUR_WEBSOCKET_URL")
  
  // P2P sync is enabled by default across all transports. Disable those
  // if you are only using Ditto Cloud Sync.
  transportConfig.setPeerToPeer(enabled: false)  
}

// Disable DQL strict mode so that collection definitions are not required in DQL queries
try await ditto.store.execute("ALTER SYSTEM SET DQL_STRICT_MODE = false")

do {
  try ditto.startSync()
} catch {
  print(error.localizedDescription)
}

Integrate the crash reporter SDK into your app, following their documentation.

Trigger a panic and check that it was registered in your crash reporter. You can use the DittoExperimental.triggerTestPanic() function to do so. At this point, without native symbols, the crash will be unreadable. If you are not seeing any crashes in the reporter, check that you have integrated its components correctly.

For release builds, you can obtain the dsym files from Xcode. They are included in the .xcarchive file. Navigate to Xcode → Window → Organizer → Archives → (Right click on a specific build) → Show in Finder → Show Package Contents → dSYMs Folder. Here you can find all the required files:

1. Your own app’s symbol file, such as MyApp.app.dSYM
2. The Ditto DittoObjC.framework.dSYM and DittoSwift.framework.dSYM files.
   Check your crash reporter’s documentation for how to do this. For example Sentry provides a CLI tool.

Trigger a new panic and notice that the crash is now symbolicated by the reporting framework.