machankura/mempool
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #984 from mempool/wiz/update-readme-for-v2.3.0

Browse Source 
Update README for upcoming v2.3.0 release
This commit is contained in:
wiz 2021-12-08 04:15:32 +00:00 committed by GitHub
commit 4633164f99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,8 +1,8 @@
# The Mempool Open Source Project # The Mempool Open Source Project™
Mempool is the fully featured visualizer, explorer, and API service running on [mempool.space](https://mempool.space/), an open source project developed and operated for the benefit of the Bitcoin community, with a focus on the emerging transaction fee market to help our transition into a multi-layer ecosystem. Mempool is the fully featured visualizer, explorer, and API service running on [mempool.space](https://mempool.space/), an open source project developed and operated for the benefit of the Bitcoin community, with a focus on the emerging transaction fee market to help our transition into a multi-layer ecosystem.
![mempool](https://mempool.space/resources/screenshots/v2.2.1-dashboard.png) ![mempool](https://mempool.space/resources/screenshots/v2.3.0-dashboard.png)
## Installation Methods ## Installation Methods
@ -20,11 +20,11 @@ The following instructions are for a manual installation on Linux or FreeBSD. Th
## Dependencies ## Dependencies
* Bitcoin Core (no pruning, txindex=1) * [Bitcoin](https://github.com/bitcoin/bitcoin)
* Electrum Server (romanz/electrs) * [Electrum](https://github.com/romanz/electrs)
* NodeJS (official stable LTS) * [NodeJS](https://github.com/nodejs/node)
* MariaDB (default config) * [MariaDB](https://github.com/mariadb/server)
* Nginx (use supplied nginx.conf and nginx-mempool.conf) * [Nginx](https://github.com/nginx/nginx)
## Mempool ## Mempool
@ -41,7 +41,7 @@ Clone the mempool repo, and checkout the latest release tag:
Enable RPC and txindex in `bitcoin.conf`: Enable RPC and txindex in `bitcoin.conf`:
```bash ```bash
rpcuser=mempool rpcuser=mempool
rpcpassword=71b61986da5b03a5694d7c7d5165ece5 rpcpassword=mempool
txindex=1 txindex=1
``` ```
@ -54,7 +54,7 @@ Install MariaDB from OS package manager:
# macOS # macOS
brew install mariadb brew install mariadb
brew services start mariadb mysql.server start
``` ```
Create database and grant privileges: Create database and grant privileges:
@ -80,7 +80,7 @@ Install mempool dependencies from npm and build the backend:
```bash ```bash
# backend # backend
cd backend cd backend
npm install npm install --prod
npm run build npm run build
``` ```
@ -96,18 +96,18 @@ Edit `mempool-config.json` to add your Bitcoin Core node RPC credentials:
"MEMPOOL": { "MEMPOOL": {
"NETWORK": "mainnet", "NETWORK": "mainnet",
"BACKEND": "electrum", "BACKEND": "electrum",
"HTTP_PORT": 8999, "HTTP_PORT": 8999
"API_URL_PREFIX": "/api/v1/",
"POLL_RATE_MS": 2000
}, },
"CORE_RPC": { "CORE_RPC": {
"HOST": "127.0.0.1",
"PORT": 8332,
"USERNAME": "mempool", "USERNAME": "mempool",
"PASSWORD": "71b61986da5b03a5694d7c7d5165ece5" "PASSWORD": "mempool"
}, },
"ELECTRUM": { "ELECTRUM": {
"HOST": "127.0.0.1", "HOST": "127.0.0.1",
"PORT": 50002, "PORT": 50002,
"TLS_ENABLED": true, "TLS_ENABLED": true
}, },
"DATABASE": { "DATABASE": {
"ENABLED": true, "ENABLED": true,
@ -116,10 +116,6 @@ Edit `mempool-config.json` to add your Bitcoin Core node RPC credentials:
"USERNAME": "mempool", "USERNAME": "mempool",
"PASSWORD": "mempool", "PASSWORD": "mempool",
"DATABASE": "mempool" "DATABASE": "mempool"
},
"STATISTICS": {
"ENABLED": true,
"TX_PER_SECOND_SAMPLE_PERIOD": 150
} }
} }
``` ```
@ -160,14 +156,14 @@ Install mempool dependencies from npm and build the frontend static HTML/CSS/JS:
```bash ```bash
# frontend # frontend
cd frontend cd frontend
npm install npm install --prod
npm run build npm run build
``` ```
Install the output into nginx webroot folder: Install the output into nginx webroot folder:
```bash ```bash
sudo rsync -av --delete dist/mempool /var/www/ sudo rsync -av --delete dist/mempool/ /var/www/
``` ```
## nginx + certbot ## nginx + certbot

BIN
frontend/src/resources/screenshots/v2.3.0-dashboard.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 365 KiB