Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pk910 authored Jul 28, 2023
1 parent c270c91 commit b2d3ccd
Showing 1 changed file with 0 additions and 44 deletions.
44 changes: 0 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,50 +11,6 @@ This "lightweight" explorer loads most of the information directly from an under

This explorer requires a postgres database.

## Setup

To run the explorer, you need to create a configuration file first. Download a copy of the [default config](https://github.com/pk910/light-beaconchain-explorer/blob/master/config/default.config.yml) and change it for your needs.

Afterwards, download the latest binary for your distribution from the [releases page](https://github.com/pk910/light-beaconchain-explorer/releases) 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](https://hub.docker.com/r/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](https://github.com/pk910/light-beaconchain-explorer/blob/master/config/default.config.yml) 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
```
3. 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`


## Background
https://github.com/ethpandaops/tooling-wishlist/blob/master/tools/lightweight-beaconchain-explorer.md

Expand Down

0 comments on commit b2d3ccd

Please sign in to comment.