> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gleap.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introducing

The Gleap SDK for Ionic / Capacitor is the easiest way to integrate Gleap into your apps. Communicate with your users directly and build better software by discovering their everyday pain points. Gleap is your all-in-one customer feedback tool for apps and websites.

For the SDK to work, you need an API key, which you can get for free at [app.gleap.io](https://app.gleap.io).

## 🏗 Installation

Installing the Gleap SDK takes only a few seconds.

<Tabs>
  <Tab title="Capacitor v5">
    Install the **Gleap** package via npm.

    ```
    npm install capacitor-gleap-plugin
    ```

    Sync your capacitor dependencies:

    ```
    npx cap sync
    ```

    ***

    Initialize the Gleap SDK by adding the following code to your index.js/.tsx file or main component.

    ```Ionic / Capacitor theme={null}
    import { Gleap } from 'capacitor-gleap-plugin';

    // Please make sure to call this method only once!
    Gleap.initialize("ogWhNhuiZcGWrva5nlDS8l7a78OfaLlV");
    ```
  </Tab>

  <Tab title="Capacitor v4">
    Install the **Gleap** package via npm.

    ```
    npm install GleapSDK/Capacitor-SDK#capacitor-v4 --save
    ```

    Sync your capacitor dependencies:

    ```
    npx cap sync
    ```

    ***

    Initialize the Gleap SDK by adding the following code to your index.js/.tsx file or main component.

    ```Ionic / Capacitor theme={null}
    import { Gleap } from 'capacitor-gleap-plugin';

    // Please make sure to call this method only once!
    Gleap.initialize("ogWhNhuiZcGWrva5nlDS8l7a78OfaLlV");
    ```
  </Tab>

  <Tab title="Capacitor v3">
    Install the **Gleap** package via npm.

    ```
    npm install capacitor-gleap-plugin@8.2.3
    ```

    Sync your capacitor dependencies:

    ```
    npx cap sync
    ```

    ***

    Initialize the Gleap SDK by adding the following code to your index.js/.tsx file or main component.

    ```Ionic / Capacitor theme={null}
    import { Gleap } from 'capacitor-gleap-plugin';

    // Please make sure to call this method only once!
    Gleap.initialize("ogWhNhuiZcGWrva5nlDS8l7a78OfaLlV");
    ```
  </Tab>
</Tabs>

<Info>
  Congrats! You are now all set 🎉 Report your first bug by using the feedback
  button
</Info>

## Required permissions (Android)

In order to use the image picker for attachments, add the following permissions to your `AndroidManifest.xml`.

```
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.READ_MEDIA_VISUAL_USER_SELECTED"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32" />
```

The following permissions are needed to enable audio recordings.

```
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-feature android:name="android.hardware.audio.pro" android:required="false" />
<uses-feature android:name="android.hardware.microphone" android:required="false" />
```

## Required permissions (iOS)

In order to use the image picker for attachments, add the following permissions to your `Info.plist`.

```
<key>NSPhotoLibraryUsageDescription</key> <string>We need access to your photo library to allow you to select an image.</string> 

<key>NSCameraUsageDescription</key> <string>We need access to your camera to take photos.</string> 
```

The following permissions are needed to enable audio recordings.

```
<key>NSMicrophoneUsageDescription</key> <string>We need access to your microphone to record audio with videos.</string>
```

## 🤝 Need help?

We are here to help! [hello@gleap.io](mailto:hello@gleap.io)