Migration Guide: From 9.5 to 9.6

The public CocoaPods Specs repository is planned to become read-only in December 2026. After that date, new pods and new pod versions will no longer be accepted there. For this reason, starting with release 9.6, new versions of Regula SDK are published to the Regula Specs repository https://github.com/regulaforensics/podspecs. Previously published versions remain available in the CocoaPods registry, and applications that use those versions will continue to function.

Note that the SDK artifacts themselves have not moved. Only the podspec metadata is published in the company-owned repository.

See the updated plugin installation guides below.

• Mobile Native SDK
  • iOS
• Mobile Hybrid SDK
  • Flutter
  • JavaScript
  • React Native (deprecated)

Mobile Native SDK

iOS

For the SDK versions 9.6 and later, explicitly add the Regula Specs repository as a dependency source in your project Podfile:

9.6< 9.6

Podfile

source 'https://github.com/regulaforensics/podspecs.git'
pod 'DocumentReader'

Podfile

source 'https://cdn.cocoapods.org/'
pod 'DocumentReader'

All other framework installation steps remain unchanged. For details, see Installation on iOS.

For the information about the most current functionality, see iOS API Reference Documentation.

Mobile Hybrid SDK

Flutter

For the SDK versions 9.6 and later, explicitly add the Regula Specs repository as a dependency source in your project ios/Podfile:

9.6< 9.6

Podfile

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/regulaforensics/podspecs.git'
...

Podfile

source 'https://github.com/CocoaPods/Specs.git'
...

All other framework installation steps remain unchanged. For details, see Installation on Flutter.

For the information about the most current functionality, see Flutter API Reference Documentation.

JavaScript

For general installation instructions, see Installation on JavaScript.

For the information about the most current functionality, see JavaScript API Reference Documentation.

For installation changes in release 9.6, see the subsections below.

Capacitor

For the SDK versions 9.6 and later, explicitly add the Regula Specs repository as a dependency source in your project ios/App/Podfile:

9.6< 9.6

Podfile

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/regulaforensics/podspecs.git'
...

Podfile

source 'https://github.com/CocoaPods/Specs.git'
pod 'DocumentReader'

React Native

ExpoWithout framework

For the SDK versions 9.6 and later, add @regulaforensics/document-reader to the plugins section in the app.config.js:

app.config.js

module.exports = ({ config }) => ({
  // ...
  plugins: [
    '@regulaforensics/document-reader',
    // ...
  ]
})

For the SDK versions 9.6 and later, explicitly add the Regula Specs repository as a dependency source in your project ios/Podfile:

9.6< 9.6

Podfile

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/regulaforensics/podspecs.git'
...

Podfile

source 'https://github.com/CocoaPods/Specs.git'
...

React Native (deprecated)

Note

Document Reader SDK 8.4 introduced a unified npm package that supports React, Ionic, and Cordova wrappers in a single JavaScript distribution. The individual wrapper packages are deprecated and scheduled for removal. For migration steps, see the Migration Guide.

For the SDK versions 9.6 and later, explicitly add the Regula Specs repository as a dependency source in your project ios/Podfile:

9.6< 9.6

Podfile

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/regulaforensics/podspecs.git'
...

Podfile

source 'https://github.com/CocoaPods/Specs.git'
...