Documentation

Everything you need to ship live updates to your Capacitor and Electron apps with DeployYourApp — from your first deploy to the full API reference.

New here?
The quick start walks you from an empty project to a delivered update.
Start the quick start
Getting Started
What the platform does, your first deployed update, and the core vocabulary.
Introduction
What DeployYourApp is, which parts of your app an OTA update can change, and the components you install.
Quick Start
Install the CLI, register an app, wire up the client, and deliver your first over-the-air update.
Core Concepts
The vocabulary DeployYourApp uses - organizations, apps, channels, bundles, deployments, rollouts, devices, and MAU.
CLI
Installing the CLI, every command and flag, configuration, and CI/CD pipelines.
Installation
Install the DeployYourApp CLI, verify it, authenticate for the first time, and run the guided setup wizard.
Command Reference
Every DeployYourApp CLI command and flag, with defaults, behavior, and example output.
Configuration
The .dya folder, the project config, the per-user global config and its location on each OS, key files, environment variables, and precedence.
CI/CD Integration
Run the DeployYourApp CLI in a pipeline with an API key, handle signing keys and secrets, and fail builds on non-zero exit codes.
Capacitor Plugin
Adding live updates to a Capacitor app: setup, configuration, and the full API.
Setup
Install the DeployYourApp Capacitor plugin, set up iOS and Android, and get a working update check.
Configuration
Every configuration option for the DeployYourApp Capacitor plugin, with types, defaults, and a full example.
API Reference
Every method, event, type, and error code of the DeployYourApp Capacitor plugin.
Update Lifecycle
How a Capacitor bundle moves from download to active, what happens on every app launch, and how rollback protection works.
App Store Review
Electron Updater
Adding live updates to an Electron app across the main, preload, and renderer processes.
Setup
Install the DeployYourApp live-update manager and wire it into an Electron app's main, preload, and renderer processes.
API Reference
Complete reference for the DeployYourApp Electron updater — main process class, IPC channels, preload bridge, renderer helpers, and events.
Update Lifecycle
How the Electron updater checks, downloads, verifies, activates, and rolls back a bundle, and how that differs from the Capacitor flow.
Dashboard
Managing apps, channels, deployments, rollouts, and your team.
Overview
A tour of the DeployYourApp web dashboard — the organization, app, and channel hierarchy, and where each screen lives.
Apps & Channels
Create apps in the DeployYourApp dashboard, understand the globally unique App ID, and manage the channels your updates are released to.
Deployments & Rollouts
Release a bundle to a channel from the DeployYourApp dashboard, roll it out gradually, roll it back, and read device and analytics results.
Team & Access
Invite members to a DeployYourApp organization, assign roles, manage API keys for CI/CD, and read the audit log.
Security
The security model, bundle signing and integrity, authentication, and data handling.
Security Overview
The DeployYourApp security model — trust boundaries, what we can and cannot see, tenant isolation, and the cryptography in use.
Code Signing
How DeployYourApp signs update bundles with RSA-4096, how each client verifies the signature and the per-file manifest, and how to rotate a signing key.
Encryption
What is encrypted at DeployYourApp and what is not — TLS in transit, field-level encryption at rest, and why update bundles are deliberately not encrypted.
Authentication
Password rules, email verification, social sign-in, TOTP two-factor, sessions, API keys, and the organization role model.
SDK Data Collection
Exactly what the Capacitor plugin and Electron updater send from end-user devices, what is stored, how long, and what you must disclose.
Incident Response
How DeployYourApp detects, contains, and reports security incidents, and how we meet notification duties under the GDPR and UK GDPR.
Billing
Plans and pricing, how usage is measured, and managing your subscription.
Plans & Pricing
Every DeployYourApp plan, its price and limits, the 30-day trial terms, and what happens when the trial ends.
Usage & Limits
How MAU, bandwidth, and storage are measured, where to see them, and exactly which limits block an action.
Billing & Invoices
Payment methods, invoices and receipts, changing plans, failed payments, and cancelling your subscription.