Skip to content

Connect the apps to your server

In progress

There’s no separate “self-hosted app”. The browser extensions, desktop apps and mobile apps work with the hosted Octa Pass service and with your own server. You pick the server when you sign in.

  1. Install Octa Pass. Until it’s in the app stores, build the apps from source.
  2. On the sign-in screen, choose Use a different server, then Self-hosted.
  3. Enter your server’s address, for example https://vault.example.com. It must use HTTPS with a valid certificate.
  4. Create an account or sign in as usual. Your Secret Key, master password and Recovery Kit work exactly as on the hosted service.

The app remembers the server for that account. Signing in to a different server means signing out first. Switching between several accounts is planned.

Everything that happens on your device is identical, because it lives in the app, not on the server:

Feature Self-hosted
Encryption, Secret Key, Recovery Kit Same
Autofill in browsers, iOS, Android, macOS Same
Passkeys Same
Face ID, Touch ID, fingerprint, Windows Hello Same
Offline access Same
Password breach checks Same: your device calls HIBP directly (see breach checks)
Import and export Same
Web vault Served by your own server at its address
Feature What you need
Verification codes and alert emails An SMTP account, set in configuration
Instant sync on phones (push, planned) Opt in to the Octa Pass push relay (below)
Email breach alerts (planned) Your own Have I Been Pwned API key, or leave the feature off
Website icons Built in. Your server fetches and caches them so the apps don’t contact icon services

Push sync isn’t built yet, on the hosted service or on self-hosted servers: phones sync when you open the app and while it’s open. Apple and Google only deliver push notifications sent with the app publisher’s credentials, so your server can’t wake the Octa Pass mobile apps directly. You’ll choose between two setups:

  • Push relay (recommended). Your server registers with the Octa Pass push relay using an installation ID and key. When a vault changes, your server sends the relay a “device X has changes” ping, and the relay forwards it through Apple or Google. No vault data, item names or account emails pass through the relay. It only receives random device identifiers.
  • No relay. Phones sync when you open the app, and in real time while it’s open. Background sync is less frequent.

Browser extensions and desktop apps don’t need the relay. They keep their own connection to your server.

  • Android without Google services (planned): an F-Droid build that syncs without Firebase (no push relay; background sync by polling).
  • Build from source: every app can be built from the repository. See development setup. Reproducible builds are planned for the extension and web vault.