Skip to content

Commit 6c7d847

Browse files
committed
docs(full node dockerfiles and tailwind): full node dockerfiles and tailwind
full node dockerfiles and tailwind
1 parent 3bba409 commit 6c7d847

File tree

11 files changed

+1566
-423
lines changed

11 files changed

+1566
-423
lines changed

Diff for: docs/full-node-setup/docker/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Using Docker",
3+
"position": 12,
4+
"className": "releaseSidebarHeading"
5+
}

Diff for: docs/full-node-setup/docker/build.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Build
3+
sidebar_position: 3
4+
---
5+
6+
# Build the Docker Images
7+
8+
1. Clone or copy the Dockerfiles and any state-sync scripts into a local directory.
9+
10+
2. Navigate to that directory.
11+
12+
3. Build your image:
13+
14+
```bash
15+
docker build -t <image-tag> -f /path/to/dockerfile .
16+
```
17+
18+
Example:
19+
20+
```bash
21+
docker build -t sentinel:mainnet -f dockerfile_sentinel_main .
22+
```
23+
24+
4. Run a container from your newly built image:
25+
26+
```bash
27+
docker run -dit --name <container-name> <image-tag>
28+
```
29+
30+
Example:
31+
32+
```bash
33+
docker run -dit --name sentinel_mainnet sentinel:mainnet
34+
```
35+
36+
5. Exec into your running container:
37+
38+
```bash
39+
docker exec -it <container-name> bash
40+
```
41+
42+
Example:
43+
44+
```bash
45+
docker exec -it sentinel_mainnet bash
46+
```
47+
48+
6. State-Sync (once inside the container):
49+
50+
```bash
51+
./state-sync.sh
52+
```
53+
54+
- This script may have a slightly different name for testnet and cosmovisor variants
55+
- Run `cat nohup` to view script output
56+
57+
7. Change Passwords
58+
59+
```bash
60+
chpasswd root
61+
chpasswd sentinel
62+
```
63+
64+
8. Transaction Setup
65+
66+
- Import your node key (e.g., `sentinelhub keys add ...`).
67+
- If you are a validator, copy your validator private key JSON into the container (see [Mount a Volume](/full-node-setup/docker/mount-volume) section).
68+
- A TMKMS Docker image is in testing and will be released soon.

Diff for: docs/full-node-setup/docker/dockerfiles.md

+647
Large diffs are not rendered by default.

Diff for: docs/full-node-setup/docker/mount-volume.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Mount a Volume
3+
sidebar_position: 4
4+
---
5+
6+
# Mount a Volume
7+
8+
Mounting a volume allows you to transfer files between the host and the container.
9+
10+
Create an empty directory on your host:
11+
12+
```bash
13+
mkdir <volume-directory-name>
14+
```
15+
16+
Attach the directory as a bind mount:
17+
18+
```bash
19+
docker run -dit \
20+
--name <container-name> \
21+
-v <host-path>:<container-path> \
22+
<image-tag>
23+
```
24+
25+
Example:
26+
27+
```bash
28+
docker run -dit \
29+
--name sentinel_mainnet \
30+
-v /home/mystuff:/mnt \
31+
sentinel:mainnet
32+
```
33+
34+
Any files placed in `/home/mystuff` on your host will now be accessible at `/mnt` inside the container.

Diff for: docs/full-node-setup/docker/overview.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Overview
3+
sidebar_position: 1
4+
---
5+
6+
# Running a Full Node by using Docker
7+
8+
Running a Full Node or Validator is now possible using Docker. You can access the GitHub repository [here](https://github.com/hindsight9923/sentinel). Special thanks to [MisfitsCrypto](https://t.me/MisfitsCrypto) for creating these Docker files!
9+
10+
11+
## Overview
12+
13+
### No ufw or systemd
14+
15+
These Dockerfiles do not use ufw or systemd. Therefore, you must manually start the node sentinelhub core after restarting or redeploying the container.
16+
Use one of the following commands inside the container:
17+
18+
```bash
19+
./state-script.sh
20+
nohup sentinelhub start &
21+
nohup cosmovisor run start &
22+
```
23+
24+
Reminder: Docker containers do not persist changes when redeployed. If you need to retain changes, modify the Dockerfile itself.
25+
26+
### Performance Tweaks
27+
28+
The Dockerfiles optimize certain parameters in config.toml and app.toml:
29+
- Indexer is off
30+
- Prometheus is on
31+
- State-sync is on
32+
- Pruning is custom (every 1000 blocks, keep last 2 snapshots)
33+
- Testnet seeds and peers are limited due to the newer network.
34+
35+
### Stability
36+
37+
Containers have been tested on both Sentinel mainnet and testnet for 3 days and appear stable, assuming adequate hardware.
38+
39+
### Additional Efforts
40+
41+
- Prometheus container with Cloud Grafana
42+
- TMKMS container (currently in testing)

Diff for: docs/sentinel-hub/README.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ An Overview of Sentinel Hub, and how developers can contribue to it.
3030
<Card
3131
title="Commands"
3232
description="overview of the main commands of Sentinel Hub"
33-
to="/sentinel-hub/category/commands"
33+
to="/sentinel-hub/commands/list"
3434
icon={<TerminalIcon />}
3535
/>
3636
<Card

0 commit comments

Comments
 (0)