Skip to main content

Web dashboard

Web dashboard

After Install, the dashboard is served from your API domain (e.g. https://updates.example.com/). Sign in with GitHub or Bitbucket OAuth, the same identity model as cmpatch login.

On the local evaluation stack, open http://localhost:8080 and sign in as local-admin@example.com (prefilled, one click). Same UI; auth is local-only.

Use the dashboard to browse teams, apps, and deployments; publish releases without memorizing CLI flags; and manage rollouts, promotion, and rollback from the UI.

info

The dashboard complements the CLI; it does not replace it. Some workflows (CI, scripting, cmpatch doctor) are CLI-only. Publishing can start in either place.

After sign-in you land in your team's workspace:

AreaWhat you do there
AppsCreate and rename apps; toggle code-signing requirements
DeploymentsStaging and Production channels per app; copy deployment keys and SDK URLs
Deployment detailRelease history (including release notes), New release, deployment-level rollback
Release detailPer-release metrics, status, and lifecycle actions
MetricsDrill from apps → deployments → deployment metrics
MembersInvite teammates and manage roles
API tokensCreate and revoke cm_pat_… tokens for CI

On a deployment detail page, expand the SDK configuration panel to copy CodemagicPatchDeploymentKey, CodemagicPatchApiUrl, and CodemagicPatchDownloadBaseUrl together. Those match the values you embed in the app; see Native setup.

Publishing a release

On a deployment detail page, click New release. You can choose how to publish:

Via CLI (command builder)

Builds a ready-to-run cmpatch release-react command from form fields:

  • Platform (iOS / Android)
  • Rollout percentage
  • Target binary version
  • Release notes
  • Mandatory flag
  • Code-signing private key path (when required by the app)

Copy the command and run it from your React Native project root or paste it into a CI job. The dashboard does not run the build for you; it generates the exact invocation with your server URL, app, and deployment filled in.

Bundle upload

Upload a pre-built .cmpatch artifact (from cmpatch bundle) directly in the browser:

  1. Select or drop the .cmpatch file
  2. Set rollout, target binary version, release notes, and mandatory if needed
  3. Submit; the server queues the release worker job

Use this when CI already produced the bundle, or you built offline and only need to publish.

Managing existing releases

From release detail or the deployment release table, open actions on a release:

ActionPurpose
Edit metadataChange release notes, target binary version, mandatory flag
RolloutAdjust rollout percentage on an active release
PromoteCopy a release to another deployment (e.g. Staging → Production)
Disable / EnableStop or resume serving a release
RollbackRevert the deployment to the previous release

Deployment-level rollback is also available from the deployment header when you need to revert without picking a specific row.

These map to cmpatch release patch, release promote, release enable/release disable, and release rollback, see Production control.

Metrics

Open Metrics in the sidebar to browse rollups by app, then by deployment. The deployment detail and release pages also surface status (uploaded, processing, published, failed, disabled) and SDK-reported counters. For CLI equivalents, see Analytics and metrics.

API tokens

Under API tokens, create personal access tokens for CI and automation. Tokens use the cm_pat_… prefix and are shown once at creation. See Security and access.

When to use the dashboard vs CLI

Prefer the dashboardPrefer the CLI
Copy a release-react command with the right flagsRun releases from CI/CD
Upload a .cmpatch without a terminalScript bulk or repeated operations
Promote, roll out, or roll back with confirmation dialogscmpatch doctor, inspect --wait, JSON output
Browse release history and keys with the teamAir-gapped or SSH-only environments

For the Staging → Production workflow, see Releasing updates.