This is the official OnlyKey documentation site. Select from the topics shown below or from the left sidebar.

Get Started With OnlyKey

The first step in getting started with OnlyKey is to follow the steps here. This will ensure you stay up to date on important OnlyKey updates.

Start Here

The users's guide provides step-by-step instructions for configuring the OnlyKey.

User's Guide

The Knowledge Base contains guides and information for using OnlyKey in specific applications.

Knowledge Base

If you are having issues that are not addressed in the User's Guide or FAQs check out the OnlyKey Support forum.

Support

OnlyKey Apps and Software

OnlyKey Desktop App is used for setup and configuration of OnlyKey. Supported on Windows, macOS, Linux, and Chrome OS (with Chrome App).

OnlyKey WebCrypt provides a way to securely use OnlyKey in the browser. The Webcrypt app loads everything necessary to encrypt messages and files directly in the local browser without the need to send messages or files over the Internet. Data between OnlyKey and the local browser is end-to-end encrypted. WebCrypt integrates with services like Keybase and Protonmail to provide OpenPGP encryption and key management everywhere on-the-go. Supports browsers Chrome, Chromium/Brave, and Firefox. Supports Windows, Mac, Linux, Android and iOS.

OnlyKey Agent is a hardware-based SSH and GPG agent that allows offline cold storage of your SSH and OpenPGP keys. SSH is a popular remote access tool that is often used by administrators and with OnlyKey remote access can be passwordless by physically pressing OnlyKey button to log in. GPG (or GnuPG) is a versatile OpenPGP tool that provides encryption and signing. Instead of keeping keys on a computer, OnlyKey generates and securely stores your keys off of the computer and you can still easily use SSH and GPG.

OnlyKey Firmware - This is the software that runs on the OnlyKey itself. The OnlyKey firmware is open source and can be loaded onto the OnlyKey by following the instructions in the User’s Guide.

The firmware releases can be found here.

OnlyKey CLI - The OnlyKey Command-Line Utility is a command line tool targeted towards more advanced users. This can be used for configuration, scripting, and testing.

OnlyKey Knowledge Base

The Knowledge Base contains guides and information for using OnlyKey in specific applications.

Linux Guide - Guide for using OnlyKey on Linux and creating a UDEV rule for OnlyKey.

OpenSSH Guide - OnlyKey can be used with OpenSSH to provide multi-factor authentication on SSH keys

Virtual Machine Guide - How to use OnlyKey with VMware and Virtualbox.

Qubes OS Guide - How to use OnlyKey with Qubes OS.

Upgrade Guide - Follow this guide to upgrade OnlyKey desktop app and firmware.

Import OpenPGP keys from Protonmail, Keybase, and Mailvelope - Export OpenPGP keys from popular services and load onto OnlyKey

Full-Disk Encryption Guide - Use OnlyKey to unlock encrypted hard drives and use with Head-less server.

Works with OnlyKey - A list of applications and things that work with OnlyKey

International Travel Edition Guide - Follow this guide to use the International Travel Edition OnlyKey.

Plausible Deniability Setup Guide - Follow this guide to use the plausible deniability feature of OnlyKey

Edit me