|
9 | 9 |
|
10 | 10 | Version 5 introduces a new **Compound Config** format that replaces the legacy "flat" config structure. This guide explains the migration steps, provides before/after examples, and details key differences. |
11 | 11 |
|
| 12 | +## 🔑 New License Key Format |
| 13 | + |
| 14 | +### Overview |
| 15 | + |
| 16 | +Version 9 uses a new **JWT-based license key** format. Your existing (legacy) license keys will **not** work with v9. |
| 17 | + |
| 18 | +> [!IMPORTANT] |
| 19 | +> Previous versions of the SDK did not require a license key on iOS. **v9 requires a license key on both iOS and Android.** See [iOS Setup](INSTALL-IOS.md) and [Android Setup](INSTALL-ANDROID.md) for license key configuration details. |
| 20 | +
|
| 21 | +> [!NOTE] |
| 22 | +> Add-on products (eg: [`polygon-geofencing`](https://shop.transistorsoft.com/collections/frontpage/products/polygon-geofencing), `firebase`) are now **encoded as entitlements** inside the JWT key itself. You no longer need separate license keys for add-on products. |
| 23 | +
|
| 24 | +### Getting Your New License Key |
| 25 | + |
| 26 | +1. Log in to the [Transistor Software Customer Dashboard](https://www.transistorsoft.com/shop/customers). |
| 27 | +2. Navigate to your product purchase. |
| 28 | +3. You will find **two license tabs**: |
| 29 | + - **Legacy** — your old license key (for `flutter-background-geolocation` v4 and below) |
| 30 | + - **New** — your new JWT license key (required for `flutter-background-geolocation` v5+) |
| 31 | +4. Copy the key from the **"New"** tab. |
| 32 | + |
| 33 | +### Applying Your License Key |
| 34 | + |
| 35 | +__[iOS]__ Add your JWT license key to your `Info.plist` under the key `TSLocationManagerLicense`. See [iOS Setup](INSTALL-IOS.md) for full details: |
| 36 | + |
| 37 | +:open_file_folder: `ios/App/App/Info.plist` |
| 38 | +```xml |
| 39 | +<key>TSLocationManagerLicense</key> |
| 40 | +<string>YOUR_JWT_LICENSE_KEY</string> |
| 41 | +``` |
| 42 | + |
| 43 | +__[Android]__ Add your JWT license key to `AndroidManifest.xml`. See [Android Setup](INSTALL-ANDROID.md) for full details: |
| 44 | + |
| 45 | +:open_file_folder: `android/app/src/main/AndroidManifest.xml` |
| 46 | +```xml |
| 47 | +<manifest> |
| 48 | + <application> |
| 49 | + <meta-data android:name="com.transistorsoft.locationmanager.license" android:value="YOUR_JWT_LICENSE_KEY" /> |
| 50 | + </application> |
| 51 | +</manifest> |
| 52 | +``` |
| 53 | + |
| 54 | +> [!WARNING] |
| 55 | +> If you previously configured a separate license key for [`polygon-geofencing`](https://shop.transistorsoft.com/collections/frontpage/products/polygon-geofencing), `firebase`, or any other add-on product, **remove it**. Add-on entitlements are now bundled into your single bgGeo JWT license key. |
| 56 | +> |
| 57 | +> |
12 | 58 | --- |
13 | 59 |
|
14 | 60 | ## ⚙️ Compatibility |
|
0 commit comments