Documentation hub

The operator manual for R2 Desk Pro.

Documentation is organized around real product workflows: setup, platform-specific behavior, bucket operations, transfer discipline, preview and delivery tooling, security posture, release workflow, and support.

Coverage map

By platform, by workflow, and by failure mode.

Use the start-here path first. Then branch by operating system, workflow, or failure pattern before you ever open support.

11core docs
3desktop platforms
Supportevidence-first only
  • App version from the About panel
  • Operating system and whether this is a release build or source build
  • Exact repro steps and the expected result
  • Actual result with screenshot or recording where relevant
Start here

The shortest reliable path to a working deployment workflow.

Follow this sequence instead of jumping between random pages. It gets a new user from installer to stable operating baseline with the least support debt.

01
Install

Get from installer to first working bucket operation

Use Quickstart for the shortest safe path: install, unlock the vault, save a profile, and run a first smoke check.

6 minQuickstart
Open step
02
Platform

Use the correct Windows, macOS, or Linux runtime path

Platform notes cover installer types, keychain behavior, local build prerequisites, and OS-specific failure patterns.

9 minPlatform setup and environment notes
Open step
03
Connect

Validate credentials before trusting the profile

Profiles and connections explains bucket-list validation, HTTPS-only fields, cache purge credentials, and delete behavior.

8 minProfiles and connections
Open step
04
Support

Know the reporting standard before something goes wrong

Support and issue reporting defines the evidence bar so defect reports start with version, repro, and the docs already followed.

7 minSupport and issue reporting
Open step
Platform coverage

Windows, macOS, and Linux are documented as first-class paths.

Platform behavior is documented separately because installers, local build prerequisites, keychain behavior, and failure patterns are not identical across the three supported desktop targets.

Deployment baseline

If a report depends on the operating system, the platform page is required reading before support treats it as a product defect.

Windows

  • NSIS .exe and .msi release artifacts
  • WebView2 and Visual Studio build-tool path for source builds
  • Antivirus and EDR interference covered explicitly

macOS

  • DMG release path and local build distinctions
  • Keychain prompts and native file access behavior
  • Xcode Command Line Tools path for source builds

Linux

  • Deb and AppImage release paths
  • GTK/WebKit and desktop keyring dependencies for source builds
  • Distro-specific behavior handled as an environment problem first
By workflow

Find the guide by the job you are actually doing.

The product is not one screen. The docs are organized around real operator tasks: connection setup, bucket operations, transfer execution, preview and delivery, settings, security, and release engineering.

Task-based entry

Open the guide for the task in front of you instead of skimming every page and hoping the right answer is somewhere in the middle.

Workflow

Browse buckets and object paths

Prefix navigation, saved shortcuts, folder semantics, bulk actions, and keyboard shortcuts.

Open guide
Workflow

Run transfers and sync safely

Queue model, retry visibility, multipart behavior, conflict policy, dry runs, and cancellation semantics.

Open guide
Workflow

Preview assets and ship links

Image and text preview eligibility, signed URLs, public URL mapping, cache purge, and estimate-based cost visibility.

Open guide
Workflow

Tune the product for daily use

Theme, density, transfer runtime, preview thresholds, URL defaults, cost assumptions, and vault policy.

Open guide
Workflow

Understand security and licensing

Vault behavior, keychain storage, HTTPS enforcement, license activation, and update checks.

Open guide
Workflow

Build, package, and verify releases

Desktop and website commands, installer output, CI expectations, and production build discipline.

Open guide
By problem

Common failure paths have dedicated entry points.

The goal is to stop vague support requests before they start. If the issue is recurring, the docs point you to the exact failure tree or operator rule.

Support reduction

A useful docs hub routes users to the right diagnostic path first. It does not ask support to sort setup drift from real defects by hand.

Profile save fails with AccessDenied

Start with Profiles and connections, then Troubleshooting. This is usually a permission issue, not a broken install.

Open path

Uploads or downloads behave unpredictably

Transfers and sync covers queue states, retrying, multipart thresholds, summaries, and cancellation semantics.

Open path

Preview, URLs, or purge actions do not line up

Preview, URLs, cache purge, and cost analysis explains file eligibility, mapping rules, and purge requirements.

Open path

The machine or distro is the variable

Platform setup and environment notes tells you when to treat the issue as Windows/macOS/Linux environment behavior first.

Open path

Getting Started

3 article(s)

6 minStart here

Quickstart

Install the app, unlock the vault, add a profile, and complete a first bucket smoke check.

WindowsmacOSLinux
SetupProfilesBrowserTransfers
  • Desktop prerequisites
  • First-launch vault setup
  • First profile validation
Read documentation
9 minCore workflow

Platform setup and environment notes

Release artifacts, native runtime behavior, filesystem differences, and local build prerequisites for Windows, macOS, and Linux.

WindowsmacOSLinux
PlatformsSetupBuildTroubleshooting
  • Release installer types by platform
  • Native keychain and dialog behavior
  • Local build prerequisites
Read documentation
8 minCore workflow

Profiles and connections

How profile validation works, which inputs are required, and what permissions the app expects.

WindowsmacOSLinux
ProfilesSecurity
  • Required and optional profile fields
  • Validation behavior
  • HTTPS enforcement
Read documentation

Operations

4 article(s)

9 minCore workflow

Bucket browser and object operations

Prefix navigation, folder semantics, search, filters, keyboard shortcuts, and object actions.

WindowsmacOSLinux
BrowserPreviewURLs
  • Prefix and folder behavior
  • Global search and local filters
  • Folder actions
Read documentation
10 minCore workflow

Transfers and sync

Upload, download, retry, multipart behavior, folder expansion, and sync plan review.

WindowsmacOSLinux
TransfersSync
  • Transfer states and summaries
  • Conflict behavior
  • Multipart and retry behavior
Read documentation
10 minCore workflow

Preview, URLs, cache purge, and cost analysis

How asset preview works, when public and signed URLs differ, how cache purge is enabled, and what the cost view is actually estimating.

WindowsmacOSLinux
PreviewURLsCacheCost
  • Inline preview eligibility
  • Public URL and signed URL behavior
  • Cloudflare cache purge requirements
Read documentation
9 minReference

Settings, defaults, and operator preferences

What every settings section controls, which values affect future jobs, and how to set the app up for daily use instead of first-launch defaults.

WindowsmacOSLinux
SettingsTransfersSyncPreview
  • General UI settings
  • Transfer and sync runtime defaults
  • Preview and URL behavior
Read documentation

Security

1 article(s)

8 minCore workflow

Security, vault, and licensing

Vault gating, keychain storage, passphrase behavior, licensing activation, and update checks.

WindowsmacOSLinux
SecurityLicensing
  • Vault lock model
  • Keychain credential handling
  • HTTPS enforcement
Read documentation

Release Engineering

1 article(s)

10 minReference

Build, packaging, and release workflow

Source builds, local quality gates, installer output, website build, and CI expectations.

WindowsmacOSLinux
BuildReleaseSetup
  • Local source prerequisites
  • Desktop and website build commands
  • Installer output paths
Read documentation

Support

2 article(s)

11 minCore workflow

Troubleshooting

Concrete fixes for the failure modes people hit first: profile save, uploads, build issues, and local environment problems.

WindowsmacOSLinux
TroubleshootingSupport
  • Profile save failures
  • Upload and download failure patterns
  • Build and runtime setup issues
Read documentation
7 minReference

Support and issue reporting

The support contract for serious users: what to read first, what evidence to include, and what gets sent back.

WindowsmacOSLinux
Support
  • What to read before contacting support
  • Required evidence checklist
  • Redaction rules
Read documentation