Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
st3b1t committed May 2, 2024
1 parent 5b9ab95 commit 3dbda04
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.satoprc
satoshitop.tar

# dotenv environment variables file
.env
Expand Down
14 changes: 13 additions & 1 deletion docs/docker.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@

## Run in Docker

You need to assign host `net` and `pid` to access the metrics in the host machine.
Build docker image from source code

```sh
$ docker build . -f ./docker/Dockerfile -t st3b1t/satoshitop:latest
```

Or using npm scripts:
```sh
$ npm run docker-build
$ npm run docker-save
```

In particular `docker-save` generare a new file name `satohitop.tar` can you copy and import in your Bitcon machine.


You need to assign host `net` and `pid` to access the metrics in the host machine.

```sh
$ docker run --rm -it --name satoshitop --net="host" --pid="host" st3b1t/satoshitop
```
Expand All @@ -17,5 +28,6 @@ cd docker
docker compose up
```


**Please Note:** for now, starting SatoshiTop requires rebooting the container in foreground and then re-running the docker command.
in the future it may be possible to keep the container running in the background and then access the output of the `satop` command executable within the container
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "satop",
"version": "2.5.0",
"version": "2.5.1",
"description": "Bitcoin full node monitoring dashboard for terminal",
"main": "./lib/satop.js",
"bin": {
Expand All @@ -13,6 +13,7 @@
"lint": "prettier --single-quote --trailing-comma es5 --write 'lib/**/*.js'",
"lint-check": "prettier --check --single-quote --trailing-comma es5 'lib/**/*.js'",
"docker-build": "docker build -f docker/Dockerfile -t st3b1t/satoshitop:latest .",
"docker-save": "docker save -o ./satoshitop.tar st3b1t/satoshitop:latest",
"docker-up": "cd docker && docker-compose up",
"test": "echo \"Test will be implemented.\" && exit 0"
},
Expand Down

0 comments on commit 3dbda04

Please sign in to comment.