Getting started

After starting the components (for example, with make run), you can begin using the OpenSigner service. This guide assumes you have already completed the Setup steps and have all components running locally.

Open the iFrame

The iFrame component is the entry point for end users. It runs on port 7050 by default. Open it in your browser to generate keys, reconstruct them for signing, and run recovery flows. The iFrame is the only place a full private key is ever assembled, and it discards the key immediately after each operation.

Explore the APIs

Each backend component exposes an HTTP API:

• Authentication service API — issues and validates access tokens.
• Hot storage API — stores frequently accessed key shares.
• Cold storage API — stores recovery shares.

The fastest way to try the endpoints is the Postman collection, which is published with Postman and mirrors the live API definitions.

Try the key flows

Once the iFrame is open, walk through the core flows:

• Create a key — split a new private key into shares.
• Recover a key — reconstruct a key on a new device.
• Sign an operation — sign using an ephemeral key.

For a refresher on how the pieces fit together, see What is OpenSigner?. The key splitting is based on Shamir's Secret Sharing.