Skip to main content

​
Installation Methods

X21 supports several deployment methods tailored to development, internal testing, staging, and production environments. All builds originate from the ClickOnce pipeline managed by Publish.ps1.

​
Standard ClickOnce Deployment

  • Usage – Recommended for most users. Provides auto-updates, signing, and rollback support.
  • Process
    1. Run .\Publish.ps1 -Environment <Env> from the repository root.
    2. The script increments the version (if configured), builds the add-in, and publishes to publish\<env>\.
    3. Upload artifacts to the configured Cloudflare R2 bucket via rclone (skipped for Dev).
    4. Users visit the channel URL (e.g., https://dl.kontext21.com/staging/) and run setup.exe.

​
ProductionLocal Packages

  • Usage – Air-gapped or controlled networks where internet distribution isn’t allowed.
  • Process
    1. Run .\Publish.ps1 -Environment ProductionLocal.
    2. The script clears the output directory, rebuilds, renames setup.exe to x21-setup-v<version>.exe, and zips the publish folder.
    3. Distribute the ZIP (x21-setup-v<version>.zip) via internal channels (SharePoint, USB).
    4. Users extract and run the bundled installer.

​
Development Builds

  • Usage – Local testing or feature development.
  • Process
    1. Build the solution in Visual Studio (Debug configuration).
    2. Launch Excel via F5; the add-in loads with the latest local changes.
    3. Optionally run .\Publish.ps1 -Environment Dev to create a ClickOnce manifest without uploading.
  • Notes – Dev builds skip git operations and uploads so developers can iterate quickly.

​
Internal & Staging Channels

  • Internal – For QA teams. Publishes to https://dl.kontext21.com/internal/ and auto-increments the revision.
  • Staging – Mirrors production infrastructure. Requires branch dev and uses production certificates.
  • Build scripts enforce branch requirements and prompt for installation confirmation before release.

​
Certificate & Trust Configuration

  • Every ClickOnce manifest must be signed. Generate or import X21_TemporaryKey.pfx during setup and replace it with a trusted certificate for production.
  • Install the certificate on client machines under Trusted Publishers so ClickOnce prompts show the verified publisher name.

​
Rolling Back

  • ClickOnce keeps previous versions accessible. Use Programs and Features → X21 → Update to revert, or republish the earlier version and instruct users to reinstall.
  • For ProductionLocal, retain prior ZIP packages so admins can redeploy if the latest build has issues.
Choose the method that balances agility with governance for your organisation.