Introduction

[中文版本]

This document is meant for customers who have opted for private RainMaker deployments for evaluation or commercial purposes. Before you go any further, let's first understand some key differences between the public RainMaker deployment and the private deployment.

Key Differences (compared to public RainMaker)

  1. Claiming: Public RainMaker uses a concept of claiming for getting the device credentials. Private deployments will have to use the RainMaker Admin CLI to generate the credentials. Check here to understand the reasons for that.
  2. Phone apps: The public RainMaker phone apps are configured to work with the public RainMaker cloud deployment. Private deployments need separate apps, configured and compiled for the specific deployments.
  3. 3rd party logins (Google, Apple, GitHub): If you want to allow your end users to use 3rd party logins, that would have to be configured separately via Google and Apple Developer accounts. GitHub login is not recommended for private deployments and so, it isn't covered in these docs.
  4. Voice Assistant Integrations: The ESP RainMaker Alexa Skill and Google Voice Assistant integration is configured for the public RainMaker deployment and would not work with private deployments. Both of these need to be configured separately.
  5. Firmware: Please check here for details on firmware considerations.
  6. CLI: Please check the CLIs section for more information.

Deployment Workflow

Now that the differences are clear, you can get started with the deployment. You may check here if you want to understand what the various components of the cloud are.

Here is the basic workflow that needs to be followed:

  1. Ensure that you have all the accounts created. Since RainMaker gives you complete control over all your data and integrations, you require the following accounts.
    • Amazon Web Services (AWS): Minimum mandatory requirement for RainMaker deployment since all the services would be deployed on AWS.
    • Google Developer Account: Required for Android app upload to Google Play store, configuring Sign in with Google (Optional), Google Voice Assistant integration (Optional), and configuring push notifications (coming soon).
    • Apple Developer Account: Required for iOS app development and upload to Apple app store, configuring Sign in with Apple (Optional, but mandatory if sign in with Google is used), and configuring push notifications (coming soon).
    • Alexa Developer Account: Required for Alexa Smart Home SKills (Optional).
  2. Complete the pre-requisites and pre-deployment steps.
  3. Get started with the RainMaker cloud deployment which consists of
  4. Use the RainMaker Admin CLI to generate the device credentials.
  5. Configure and compile the phone apps to work with your cloud deployment. Check the Android and iOS configuration docs

Optional Features

The above are sufficient to get to a minimum working state. The below steps are optional, but required for most use cases.

  1. Configure Sign in with Google and Sign in with Apple. (Note: We do not support sign in with Github on private deployments since it is not a common requirement as such).
  2. Configure the Alexa Smart Home Skill and get it Certified. (Note: A seperate Works with Alexa product certification is also required separately)
  3. Configure Google Voice Assistant Actions and get it Certified.
RainMaker Cloud →