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

# Installation

> Build the Quantum Chain reference client and tooling from source.

The Quantum Chain reference client is distributed as source. Build it with Go 1.24 or later.

## Prerequisites

| Tool       | Version                |
| ---------- | ---------------------- |
| Go         | 1.24+                  |
| GNU Make   | any                    |
| C compiler | gcc or clang (for cgo) |
| Git        | any                    |

## Build from source

```bash theme={null}
git clone https://github.com/Quantum-Chain-PTE-LTD/go-quantum-chain.git
cd go-quantum-chain
make geth
```

The `geth` binary lands at `build/bin/geth`. Confirm:

```bash theme={null}
./build/bin/geth version
```

To build all supporting tools:

```bash theme={null}
make all
```

This produces:

| Binary                   | Purpose                                      |
| ------------------------ | -------------------------------------------- |
| `build/bin/geth`         | Full Quantum Chain node                      |
| `build/bin/keygenerator` | Generate post-quantum keypairs and mnemonics |
| `build/bin/ethkey`       | Inspect and manage keystore files            |
| `build/bin/clef`         | External signer (hot wallet)                 |
| `build/bin/abigen`       | Solidity ABI binding generator               |
| `build/bin/bootnode`     | Discovery v4 bootnode                        |
| `build/bin/evm`          | Standalone QVM for testing                   |
| `build/bin/rlpdump`      | RLP decoder                                  |
| `build/bin/qc-custody`   | Qustody custody service binary               |

## Verify the build

Run the unit-test suite:

```bash theme={null}
go test ./...
```

To run only the post-quantum signature tests:

```bash theme={null}
go test ./crypto/...
```

## Container image

A multi-stage Dockerfile is provided at the repo root:

```bash theme={null}
docker build -t quantum-chain:latest .
docker run --rm -p 8545:8545 -p 30303:30303 quantum-chain:latest \
  --networkid 20803 \
  --http --http.addr 0.0.0.0 --http.port 8545
```

For all-in-one images including ancillary tooling, use `Dockerfile.alltools`.

## System requirements

| Profile                   | RAM   | Disk       | Notes                                      |
| ------------------------- | ----- | ---------- | ------------------------------------------ |
| Light client              | 4 GB  | 30 GB SSD  | Enough for read-only RPC                   |
| Full node                 | 16 GB | 1 TB SSD   | Recommended for most operators             |
| Archive node              | 32 GB | 4 TB+ NVMe | Required only if you need historical state |
| Validator (Clique sealer) | 8 GB  | 500 GB SSD | Plus highly available networking           |

## Where to go next

* [Quickstart: run a node](/quantum-chain/quickstart-node)
* [Configuration](/quantum-chain/configuration)
* [Accounts and keys](/quantum-chain/accounts-and-keys)