> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canton.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Install the Wallet Gateway, configure it, run it against a network, and verify it is up.

This is the shortest path to a running Wallet Gateway: install it, generate a configuration
file, start it against a Canton network, and confirm its three endpoints respond. It targets
a local setup you can adapt to your own validator.

<Note>
  You need Node.js (tested with v24) and access to a Canton network's Ledger API. For a fully
  local target, run a [Splice LocalNet](/sdks-tools/development-tools/localnet).
</Note>

<Steps>
  <Step title="Install the Wallet Gateway">
    Install globally with npm:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    npm install -g @canton-network/wallet-gateway-remote
    ```

    Or run it without installing, using `npx`:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    npx @canton-network/wallet-gateway-remote -c ./config.json
    ```

    `npx` downloads and runs the latest version each time, which is useful for one-off runs.
  </Step>

  <Step title="Generate a configuration file">
    Write an example configuration you can edit:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    wallet-gateway --config-example > config.json
    ```

    The example targets a Splice LocalNet with SQLite storage and a mock OAuth identity provider.
  </Step>

  <Step title="Edit the configuration">
    Open `config.json` and set, at minimum:

    * **Store**: where the Wallet Gateway persists data (`memory`, `sqlite`, or `postgres`).
    * **Networks**: at least one Canton network with its Ledger API `baseUrl`.
    * **Identity providers**: how users authenticate against those networks.

    See [Configure the Wallet Gateway](/integrations/wallet-gateway/operate/configure) for every option, and
    [Networks & identity providers](/integrations/wallet-gateway/operate/networks-and-identity) to
    wire up authentication.
  </Step>

  <Step title="Start the Wallet Gateway">
    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    wallet-gateway -c ./config.json
    ```

    Override the port with `-p` if needed:

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    wallet-gateway -c ./config.json -p 8080
    ```
  </Step>

  <Step title="Verify it is running">
    The Wallet Gateway exposes three endpoints (default port `3030`):

    * **User UI**: `http://localhost:3030`
    * **dApp API**: `http://localhost:3030/api/v0/dapp`
    * **User API**: `http://localhost:3030/api/v0/user`

    Open the User UI in your browser to confirm the Wallet Gateway is up.
  </Step>
</Steps>

## Command-line options

| Option                      | Description                                                 |
| --------------------------- | ----------------------------------------------------------- |
| `-c, --config <path>`       | Set the config path (default: `./config.json`).             |
| `--config-schema`           | Output the config JSON Schema and exit.                     |
| `--config-example`          | Output an example config and exit.                          |
| `-p, --port [port]`         | Set the port (overrides the config file).                   |
| `-f, --log-format <format>` | Set the log format: `json` or `pretty` (default: `pretty`). |

The `--config-schema` output is a complete JSON Schema you can use for validation and IDE
autocompletion.

## Next steps

<CardGroup cols={2}>
  <Card title="Configure the Wallet Gateway" href="/integrations/wallet-gateway/operate/configure">
    All configuration options for kernel, server, and store.
  </Card>

  <Card title="Networks & identity providers" href="/integrations/wallet-gateway/operate/networks-and-identity">
    Connect to a validator and set up authentication.
  </Card>

  <Card title="Manage wallets" href="/integrations/wallet-gateway/use/manage-wallets">
    Create and manage wallets through the User UI or User API.
  </Card>

  <Card title="Deploy" href="/integrations/wallet-gateway/operate/deploy">
    Run the Wallet Gateway with Docker or Helm.
  </Card>
</CardGroup>