https://github.com/doctorlai/simple-steem-docker
The simple steem docker helper utility
https://github.com/doctorlai/simple-steem-docker
blockchain docker steem steemd steemit witness
Last synced: 22 days ago
JSON representation
The simple steem docker helper utility
- Host: GitHub
- URL: https://github.com/doctorlai/simple-steem-docker
- Owner: DoctorLai
- License: mit
- Created: 2024-09-11T10:54:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-03T15:35:18.000Z (about 1 year ago)
- Last Synced: 2025-07-03T13:58:08.421Z (11 months ago)
- Topics: blockchain, docker, steem, steemd, steemit, witness
- Language: Shell
- Homepage: https://steemyy.com
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Docker Steem Witness Node Utility
This utility script helps manage a Steem witness node using Docker. You can start, stop, restart, force kill, debug, print configuration, check status, and view logs of the witness node container with simple commands.
---
## Requirements
- Docker installed and running
- A Steem witness node Docker image (For example: `justyy/steem:ubuntu24.04`). See all images at [justyy/steem](https://hub.docker.com/r/justyy/steem)
---
## Environment Variables
The following environment variables can be used to customize the behavior of the script. The script respects any environment variable you export before running it. If a variable is not set, the default value will be used.
---
### `DOCKER_NAME`
- **Description:** The name of the Docker container that will run the Steem witness node.
- **Default:** `steem`
- **Example:**
export DOCKER_NAME="steem"
---
### `DOCKER_IMAGE`
- **Description:** The Docker image that will be used to run the Steem witness node.
- **Default:** `steem:latest`
- **Example:**
export DOCKER_IMAGE="steem:latest"
You can pull prebuilt images from [justyy/steem](https://hub.docker.com/r/justyy/steem/tags), for example:
docker pull justyy/steem:ubuntu24.04
---
### `LOCAL_STEEM_LOCATION`
- **Description:** The local directory where Steem data will be stored. This directory will be mounted to the Docker container i.e. `/steem`.
- **Default:** `/root/steem-docker/data/witness_node_data_dir`
- **Example:**
export LOCAL_STEEM_LOCATION="/root/steem-docker"
---
### `SEED_PORT` and `API_PORT`
- **SEED_PORT:** Port mapping for the Steem witness node seed port (default `-p 2001:2001`)
- **API_PORT:** Port mapping for the HTTP RPC port (default `-p 8091:8091`)
You can remove or change these in the script e.g. if you don't want to expose the API port.
---
### `ULIMIT_NUMBER`
- **Description:** Number of file descriptors allowed for the container.
- **Default:** `999999`
> Usually, you don't need to change this value.
---
## Usage
To customize the behavior of the script, set any of the environment variables listed above before running the script. If you do not set any of the variables, the script will use the default values.
- **DOCKER_NAME:** `steem`
- **DOCKER_IMAGE:** `steem:latest`
- **LOCAL_STEEM_LOCATION:** `/root/steem-docker/data/witness_node_data_dir`
---
### Example with Custom Environment Variables
export DOCKER_NAME="my_steem_node"
export DOCKER_IMAGE="custom_steem_image:latest"
export LOCAL_STEEM_LOCATION="/mnt/custom_steem_data"
---
## Script Commands
### Start the Steem Witness Node
./run.sh start
- Starts the Steem witness node in a Docker container.
- Maps the following ports by default:
- `2001:2001` – Seed port
- `8091:8091` – HTTP RPC port
- Mounts Steem data to `$LOCAL_STEEM_LOCATION` on the host.
---
### Stop the Steem Witness Node
./run.sh stop
- Stops the Steem witness node container gracefully with a timeout of 600 seconds.
- Removes the container after stopping.
---
### Force Kill the Steem Witness Node
./run.sh kill
- Immediately stops the container and removes it, regardless of its state.
---
### Restart the Steem Witness Node
./run.sh restart
- Stops and then starts the container. Equivalent to running:
./run.sh stop
./run.sh start
---
### Start a Test Steem Container
./run.sh test
- Starts the container interactively with a `/bin/bash` shell.
- Useful for inspecting the container or running commands manually.
---
### Debug the Steem Witness Node
./run.sh debug
- Debug the running steem container
---
### Print Current Configuration
./run.sh print
- Prints the current parameters used by the script, including:
- `DOCKER_NAME`
- `DOCKER_IMAGE`
- `LOCAL_STEEM_LOCATION`
- `SEED_PORT`
- `API_PORT`
- `DOCKER_ARGS`
- `ULIMIT_NUMBER`
---
### Check Container Status
./run.sh status
- Displays detailed container information:
- Running state
- Container ID
- Image name
- Ports
- Mounted volumes
- Ulimit and restart policy
- CPU and memory usage
---
### Wallet Cli
./run.sh wallet
- Launch a wallet_cli connected to local steemd at port 8090 (which can be specified in env variable `STEEM_WS_PORT`)
---
### View Logs of the Steem Witness Node
./run.sh logs
- Tails the last 100 lines of the container logs by default and follows new entries.
- To show a different number of lines:
./run.sh logs 500
- To show all:
./run.sh logs all
---
### Install Docker
./run.sh install_docker
- This is a quick short cut to install the docker.