Self Hosting Whatfix Mobile content

Note:

To enable the feature, contact support@whatfix.com.

Whatfix Mobile enables you to download the content you have created and host it on your own servers. Self Hosting is useful when you are on an internal network and cannot access the in-app experience from the Whatfix cloud or when your IT security doesn't enable resource loading from remote servers. With Self Hosting, create the in-app experience on the Whatfix cloud and export it as a .zip file for hosting on your CDN (Content Distribution Network) or private server.

Use the following steps to self host Whatfix Mobile content:

1. On the Whatfix Mobile Dashboard, select the App containing the Projects you want to export.

2. Click App Settings.

3. In the Export content section, click Export.

Info:

• The project you create needs to be published before you export it.

• After you export the App, an email with a link to download the content is sent to your registered email address.

 

4. To download the .zip file, go to the email and then click Download Package.

5. Unzip the file and upload the Whatfix folder to your server. 

Note:

• The folder name is a UUID (a 36-character alphanumeric string) that contains the whatfix folder. 

• The Whatfix folder includes all the resources and assets required for the SDK to run on Self hosted mode.

Info:

• Here's how the extracted folder looks like:
  

• Ensure that you keep the folder structure intact while uploading it to your server.

• If you update your Whatfix Mobile content, you have to publish it and then export the .zip file again.

6. After uploading the content to your server, add the following code as per your platform while initializing the SDK to fetch Whatfix Mobile content from your CDN or server.

Note:

Ensure that the URL ends with a slash('/'). For example, https://xyz.test.com/self-hosting/

Info:

The Self Hosting feature is available only for SDK versions equal to and above the following versions:

Android: 2.0.10

iOS: 2.0.7

React Native (Android and iOS): 2.0.10

Xamarin (Android and iOS): 2.0.7

Cordova (Android and iOS): 2.0.7

Ionic: 1.2.0

MAUI Android: 2.0.7

Leap.startWithSelfHostingEnabled("API_KEY", "SELF_HOSTING_BASE_URL");

Leap.shared.withSelfHostedBuilder()?.setBaseUrl("SELF_HOSTING_BASE_URL")?.start("API_KEY")

LeapReactNative.startWithSelfHostingEnabled("API_KEY", "SELF_HOSTING_BASE_URL");

Leap.WithSelfHostedBuilder()
    .SetBaseUrl("SELF_HOSTING_URL")
    .Start("API_KEY");

Leap.startWithSelfHostingEnabled("API_KEY", "SELF_HOSTING_BASE_URL");

Leap.WithSelfHostedBuilder()
    .SetBaseUrl("SELF_HOSTING_BASE_URL")
    .Start("API_KEY");

let selfHostingBaseUrl:String = "https://assets.selfhosting.com/self-hosting/"
Leap.Shared.WithSelfHostedBuilder()?.SetBaseUrl(selfHostingBaseUrl)?.Start("API_KEY")

cordova.plugins.LeapAndroid.startWithSelfHostingEnabled("API_KEY","SELF_HOSTING_BASE_URL")

cordova.plugins.LeapiOS.startWithSelfHostingEnabled("API_KEY","BASE_URL");

LeapPlugin.startWithSelfHostingEnabled({"apiKey":"API_KEY", "baseUrl":"SELF_HOSTING_BASE_URL"})