Skip to content

Latest commit

 

History

History
144 lines (99 loc) · 8.33 KB

README.md

File metadata and controls

144 lines (99 loc) · 8.33 KB
Raw

CodePush Server

The CodePush Server is a Node.js application that powers the CodePush Service. It allows users to deploy and manage over-the-air updates for their react-native applications in a self-hosted environment.

Please refer to react-native-code-push for instructions on how to onboard your application to CodePush.

Deployment

Local

Prerequisites

The CodePush Server requires Azure Blob Storage to operate. For the local setup, there is an option to use emulated local storage with Azurite. Please follow Azurite official documentation to install and run it locally. Additionally, you need to specify EMULATED flag equals true in the environmental variables.

Steps

To run the CodePush Server locally, follow these steps:

  1. Clone the CodePush Service repository to your local machine.

  2. Copy the .env.example file to a new file named .env in the root directory:

    cp .env.example .env

    Fill in the values for each environment variable in the .env file according to your development or production setup.

  3. Install all necessary dependencies:

    npm install

  4. Compile the server code:

    npm run build

  5. Launch the server with the environment-specific start command:

    npm run start:env

By default, local CodePush server runs on HTTP. To run CodePush Server on HTTPS:

  1. Create a certs directory and place cert.key (private key) and cert.crt (certificate) files there.
  2. Set environment variable HTTPS to true.

Warning! When hosting CodePush on Azure App Service HTTPS is enabled by default.

For more detailed instructions and configuration options, please refer to the ENVIRONMENT.md file.

Azure

CodePush Server is designed to run as Azure App Service.

Prerequisites

To deploy CodePush to Azure, an active Azure account and subscription are needed. For more information, follow Azure's official documentation. During the deployment process, the included bicep script will create bare minimum Azure services needed to run CodePush Server including:

  1. Service plan
  2. App Service
  3. Storage account

Additionally, for user authentication, a GitHub or Microsoft OAuth application is needed. More detailed instructions on how to set up one can be found in the section OAuth Apps.

Steps

NOTE Please be aware of project-suffix naming limitations for resources in Azure .

  1. Login to your Azure account: az login
  2. Select subscription for deployment: az account set --subscription <subscription-id>
  3. Create resource group for CodePush resources: az group create --name <resource-group-name> --location <az-location eg. eastus>
  4. Deploy infrastructure with the next command: az deployment group create --resource-group <resource-group-name> --template-file ./codepush-infrastructure.bicep --parameters project_suffix=<project-suffix> az_location=<az-location eg. eastus> github_client_id=<github-client-id> github_client_secret=<github-client-secret> microsoft_client_id=<microsoft-client-id> microsoft_client_secret=<microsoft-client-secret>. OAuth parameters (both GitHub and Microsoft) are optional. It is possible to specify them after the deployment in environment settings of Azure WebApp.
  5. Deploy CodePush to the Azure WebApp created during infrastructure deployment. Follow the Azure WebApp official documentation "Deployment and configuration" section for detailed instructions.

Warning! The created Azure Blob Storage has default access settings. This means that all users within the subscription can access the storage account tables. Adjusting the storage account access settings to ensure proper security is the responsibility of the owner.

Configure react-native-code-push

In order for react-native-code-push to use your server, additional configuration value is needed.

Android

in strings.xml, add following line, replacing server-url with your server.

<string moduleConfig="true" name="CodePushServerUrl">server-url</string>

iOS

in Info.plist file, add following lines, replacing server-url with your server.

<key>CodePushServerURL</key>
<string>server-url</string>

OAuth apps

CodePush uses GitHub and Microsoft as identity providers, so for authentication purposes, you need to have an OAuth App registration for CodePush. Client id and client secret created during registration should be provided to the CodePush server in environment variables. Below are instructions on how to create OAuth App registrations.

GitHub

  1. Go to https://github.com/settings/developers
  2. Click on New OAuth App
  3. Homepage URL parameter will be the same as URL of your CodePush application on Azure - https://codepush-<project-suffix>.azurewebsites.net (for local development it will be either http://localhost:3000 or https://localhost:8443)
  4. Authorization callback URL will be https://codepush-<project-suffix>.azurewebsites.net/auth/callback/github (for local development it will be either http://localhost:3000/auth/callback/github or https://localhost:8443/auth/callback/github)

Microsoft

Both work and personal accounts use the same application for authentication. The only difference is property Supported account types that is set when creating the app.

  1. Register an Azure Registered Application following official guideline
  2. For option Supported account types:
    1. If you want to support both Personal and Work accounts, select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)
    2. If you want to only support Work accounts, choose either Accounts in this organizational directory only (<your directory> - Single tenant) or Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant) depending if you want to support Single or Multitenant authorization. Make sure to set MICROSOFT_TENANT_ID envrionment variable in case of using single tenant application.
    3. If you want to only support Personal accounts, select Personal Microsoft accounts only
  3. Set up Redirect URI(s) depending on the choice you made for Supported account types. If you choose both Personal and Work accounts, you need to add both redirect URIs, otherwise just one of the ones:
    1. Personal account: https://codepush-<project-suffix>.azurewebsites.net/auth/callback/microsoft (for local development it will be either http://localhost:3000/auth/callback/microsoft or https://localhost:8443/auth/callback/microsoft)
    2. Work account: https://codepush-<project-suffix>.azurewebsites.net/auth/callback/azure-ad (for local development it will be http://localhost:3000/auth/callback/azure-ad or https://localhost:8443/auth/callback/azure-ad)
  4. Generate secret following this official guideline

Naming limitations

project-suffix

  1. Only letters are allowed.
  2. Maximum 15 characters.

Metrics

Installation metrics allow monitoring release activity via the CLI. For detailed usage instructions, please refer to the CLI documentation.

Redis is required for Metrics to work.

Steps

  1. Install Redis by following official installation guide.
  2. TLS is required. Follow official Redis TLS run guide.
  3. Set the necessary environment variables for Redis.