Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aureleoules/lumiere
💡 lumière is a simple self-hosted bitcoin block explorer
https://github.com/aureleoules/lumiere
bitcoin explorer
Last synced: 3 days ago
JSON representation
💡 lumière is a simple self-hosted bitcoin block explorer
- Host: GitHub
- URL: https://github.com/aureleoules/lumiere
- Owner: aureleoules
- License: mit
- Created: 2020-05-29T01:16:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-09T21:17:34.000Z (almost 2 years ago)
- Last Synced: 2023-03-03T13:02:27.068Z (over 1 year ago)
- Topics: bitcoin, explorer
- Language: TypeScript
- Homepage:
- Size: 2.13 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lumière
Simple Bitcoin block explorer
## Get started
Here is the process to install lumière.
### Need a new BTCD node? (Recommended)
Create a `.env` file from the `.env.sample` template.
Leave the HOST variable as `btcd`.
Checkout [Environment Variables](#environment-variables) for more informations.
Make sure to create a volume containing the chain data and a volume containing TLS certificates.
```bash
$ docker volume create btcd_data
$ docker volume create btcd_certs
```
Now run the app.
```
$ docker-compose up
```
Checkout [localhost:8000]().
### Already have a BTCD node?
If you already have a btcd node running, make sure it has the `--txindex` and `--addrindex` parameters.
Create a `.env` file from the `.env.sample` template. Checkout [Environment Variables](#environment-variables) for more informations.
Make sure to create a volume containing TLS certificates to connect to your node.
```bash
$ docker volume create btcd_certs
```
Now run the app.
```bash
$ docker-compose -f docker/docker-compose.lumiere.yml up
```
Check out [localhost:8000]().
## Development
Copy `.env.sample` to `.env`.
```bash
$ cp .env.sample .env
```
Make sure to create a volume containing the chain data and a volume containing TLS certificates.
```bash
$ docker volume create btcd_data
$ docker volume create btcd_certs
```
Now run the development environment.
```bash
$ docker-compose -f docker/docker-compose.dev.yml up
```
This will start a BTCD node on the test network, the Go API and the UI.
The API is available at [localhost:8000/api]().
The UI is available at [localhost:3000]().
## Environment variables
* RPC_USER # RPC username
* RPC_PASS # RPC password
* RPC_HOST # RPC host or ip
* RPC_PORT # RPC port (optional)
* TESTNET # Use testnet (TESTNET=1)
* CERTS_LOCATION # Location of TLS certificates (optional)