Home

Welcome to the light-beaconchain-explorer wiki!

Setup

Use Release

To run the explorer, you need to create a configuration file first. Download a copy of the default config and change it for your needs.

Afterwards, download the latest binary for your distribution from the releases page and start the explorer with the following command:

./explorer_linux_amd64 -config=explorer-config.yaml

You should now be able to access the explorer via http://localhost:8080

Use docker image

I'm maintaining a docker image for this explorer: pk910/light-beaconchain-explorer

There are various images available:

• latest: The latest release
• unstable: That latest master branch version (automatically built)
• v1.x.x: Version specific images for all releases.

Follow these steps to run the docker image:

1. Create a copy of the default config and change it for your needs.
   You'll especially need to configure the chain, beaconapi & database sections.

   wget -O explorer-config.yaml https://raw.githubusercontent.com/pk910/light-beaconchain-explorer/master/config/default.config.yml
   nano explorer-config.yaml
   

2. Start the container

   docker run -d --restart unless-stopped --name=beaconlight -v $(pwd):/config -p 8080:8080 -it pk910/light-beaconchain-explorer:latest -config=/config/explorer-config.yaml
   

You should now be able to access the explorer via http://localhost:8080

read logs:

docker logs beaconlight --follow

stop & remove container:

docker stop beaconlight

docker rm -f beaconlight

Build from source

To build the explorer from source, you need a machine with go 1.20 installed.

Run the following commands to clone the repository and compile the binaries:

git clone https://github.com/pk910/light-beaconchain-explorer.git
cd light-beaconchain-explorer
make

This should build the binaries to ./bin.
Afterwards, you can run the binary as described in the "Use Release" section.