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

Remove $ from commands in repo docs

Browse Source
This commit is contained in:
hunicus 2022-05-09 01:13:54 -04:00
parent 953f9405fc
commit 9a2043fab2
No known key found for this signature in database
GPG Key ID: 24837C51B6D81FD9
2 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -41,10 +41,10 @@ You will need [Bitcoin Core](https://github.com/bitcoin/bitcoin), [Electrum Serv
Clone the Mempool repo, and checkout the latest release tag: Clone the Mempool repo, and checkout the latest release tag:
```bash ```bash
$ git clone https://github.com/mempool/mempool git clone https://github.com/mempool/mempool
$ cd mempool cd mempool
$ latestrelease=$(curl -s https://api.github.com/repos/mempool/mempool/releases/latest|grep tag_name|head -1|cut -d '"' -f4) latestrelease=$(curl -s https://api.github.com/repos/mempool/mempool/releases/latest|grep tag_name|head -1|cut -d '"' -f4)
$ git checkout $latestrelease git checkout $latestrelease
``` ```
### 2. Configure Bitcoin Core ### 2. Configure Bitcoin Core
@ -63,11 +63,11 @@ Install MariaDB from your OS package manager:
```bash ```bash
# Debian, Ubuntu, etc. # Debian, Ubuntu, etc.
$ apt-get install mariadb-server mariadb-client apt-get install mariadb-server mariadb-client
# macOS # macOS
$ brew install mariadb brew install mariadb
$ mysql.server start mysql.server start
``` ```
Create a database and grant privileges: Create a database and grant privileges:
@ -88,15 +88,15 @@ Query OK, 0 rows affected (0.00 sec)
Install Mempool dependencies with npm and build the backend: Install Mempool dependencies with npm and build the backend:
```bash ```bash
$ cd backend cd backend
$ npm install --prod npm install --prod
$ npm run build npm run build
``` ```
In the `backend` folder, make a copy of the sample config: In the `backend` folder, make a copy of the sample config:
```bash ```bash
$ cp mempool-config.sample.json mempool-config.json cp mempool-config.sample.json mempool-config.json
``` ```
Edit `mempool-config.json` with your Bitcoin Core node RPC credentials: Edit `mempool-config.json` with your Bitcoin Core node RPC credentials:
@ -133,7 +133,7 @@ Edit `mempool-config.json` with your Bitcoin Core node RPC credentials:
Start the backend: Start the backend:
```bash ```bash
$ npm run start npm run start
``` ```
When it's running, you should see output like this: When it's running, you should see output like this:
@ -164,15 +164,15 @@ Updating mempool
Install the Mempool dependencies with npm and build the frontend: Install the Mempool dependencies with npm and build the frontend:
```bash ```bash
$ cd frontend cd frontend
$ npm install --prod npm install --prod
$ npm run build npm run build
``` ```
Install the output into the nginx webroot folder: Install the output into the nginx webroot folder:
```bash ```bash
$ sudo rsync -av --delete dist/ /var/www/ sudo rsync -av --delete dist/ /var/www/
``` ```
### 6. `nginx` + `certbot` ### 6. `nginx` + `certbot`
@ -181,13 +181,13 @@ Install the supplied `nginx.conf` and `nginx-mempool.conf` in `/etc/nginx`:
```bash ```bash
# install nginx and certbot # install nginx and certbot
$ apt-get install -y nginx python3-certbot-nginx apt-get install -y nginx python3-certbot-nginx
# install the mempool configuration for nginx # install the mempool configuration for nginx
$ cp nginx.conf nginx-mempool.conf /etc/nginx/ cp nginx.conf nginx-mempool.conf /etc/nginx/
# replace example.com with your domain name # replace example.com with your domain name
$ certbot --nginx -d example.com certbot --nginx -d example.com
``` ```
If everything went well, you should see the beautiful mempool :grin: If everything went well, you should see the beautiful mempool :grin:

4
docker/README.md
View File

@ -34,7 +34,7 @@ The IP address in the example above refers to Docker's default gateway IP addres
Now, run: Now, run:
```bash ```bash
$ docker-compose up docker-compose up
``` ```
Your Mempool instance should be running at http://localhost. The graphs will be populated as new transactions are detected. Your Mempool instance should be running at http://localhost. The graphs will be populated as new transactions are detected.
@ -59,7 +59,7 @@ Of course, if your Docker host IP address is different, update accordingly.
With `bitcoind` and Electrum Server set up, run Mempool with: With `bitcoind` and Electrum Server set up, run Mempool with:
```bash ```bash
$ docker-compose up docker-compose up
``` ```
## Further Configuration ## Further Configuration