Explorer installation (preparation)

This is Part 1 — everything to prepare before you install the explorer. Complete the server preparation step in this section first.

1. Create the Deployment Directory

Terminal window
mkdir -p /data/openscan && cd /data/openscan

All configuration lives here. Put this directory (minus secrets) under version control.

2. Gather Chain Connection Details

You need from your chain node (see Chain Node Layer):

  • JSON-RPC HTTP endpoint, e.g. http://10.0.0.5:8545
  • Trace-enabled endpoint (often the same URL)
  • Chain ID — verify with:
Terminal window
curl -s -X POST http://10.0.0.5:8545 \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":1}'

3. Write the Environment File

Create /data/openscan/.env:

Terminal window
# Chain
CHAIN_ID=50
ETHEREUM_JSONRPC_HTTP_URL=http://10.0.0.5:8545
ETHEREUM_JSONRPC_TRACE_URL=http://10.0.0.5:8545


# Database
DB_PASSWORD=generate-a-long-random-string


# Branding
NEXT_PUBLIC_NETWORK_NAME="Your Chain"
NEXT_PUBLIC_NETWORK_COIN=XYZ

Restrict permissions — this file contains secrets:

Terminal window
chmod 600 .env

4. Prepare Branding Assets

Place your logo files (light/dark), favicon, and social preview image in /data/openscan/branding/. See Branding & Configuration for supported formats and sizes.

5. Plan DNS

Decide the public domain now:

  • explorer.yourchain.example — frontend and API behind one hostname (path-routed), or
  • separate names for UI and API if you prefer

Create the DNS records pointing at your server. TLS issuance in Part 2 needs DNS already resolving.

6. Review Storage

Confirm your database volume target matches the layout from the server preparation step and read Persistent Storage & Backups so backups are configured from day one.

Checklist Before Part 2

  • .env written with verified chain ID and RPC URLs
  • Secrets permissions set (chmod 600)
  • Branding assets in place
  • DNS records created and resolving
  • Backup destination decided

Continue to Explorer Installation (Install).

Edit page on github
Storage & Backups Explorer installation (install)