Skip to content
This repository was archived by the owner on Jan 31, 2022. It is now read-only.

Commit 1778676

Browse files
author
Clément Le Provost
committed
[offline] Update documentation: required ACLs in API key [ci skip]
The offline mode requires additional ACLs: browse and get settings.
1 parent 48aa889 commit 1778676

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/offline-mode.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,21 @@ Offline features are brought by Algolia's **Offline SDK**, which is actually com
2727

2828
## Setup
2929

30+
### Prerequisites
31+
3032
1. Obtain a **license key** from [Algolia](https://www.algolia.com/).
3133

34+
2. Make sure you use an **API key** with the following ACLs:
35+
36+
- Search (`search`)
37+
- Browse (`browse`)
38+
- Get index settings (`settings`)
39+
40+
*This is required because the offline mode needs to replicate the online index's settings and uses browse requests when syncing.*
41+
42+
43+
### Steps
44+
3245
2. In your Gradle script, use the `algoliasearch-offline-android` package in place of `algoliasearch-android`. Typically:
3346

3447
```groovy

0 commit comments

Comments
 (0)