Skip to content
SLPDB running inside a Docker container, managed by Docker Compose
TypeScript Dockerfile Shell JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
slpserve
.env
.gitignore
Dockerfile
LICENSE.md
README.md Update README.md Sep 14, 2019
bkup-config.ts
cleanup-images.sh
docker-compose.yml
dummyapp.js
enter-image.sh
run-script.sh
startup-script.sh

README.md

docker-slpdb

This Docker container sets up SLPDB and slpserve to create API endpoints for querying SLP token information.

Installation

It's assumed that you are starting with a fresh installation of Ubuntu 18.04 LTS on a 64-bit machine. It's also assumed that you are installing as a non-root user with sudo privileges.

  • Install Docker on the host system. This tutorial shows how to install Docker on a Ubuntu 16.04 system. It's specifically targeted to Digital Ocean's cloud servers, but should work for any Ubuntnu system.

  • Install Docker Compose too. This tutorial shows how to do so on a Ubuntu system.

  • Ensure you have a fully-synced BCH full node for SLPDB to query. This docker-abc dockerized full node will do exactly this.

  • Clone this repository in your home directory with the following command:

git clone https://github.com/christroutner/docker-slpdb

  • Create two additional directories in the same folder as the docker-slpdb folder:

    • config - will contain persistent configuration data to customize SLPDB.
    • data - will contain LevelDB and MongoDB database data.
      • Inside this directory, create two more directories: leveldb and mongodb
  • Customize the run-script.sh bash script file with the environment variables for your full node. Copy this file to the config directory you created earlier.

  • (optional) By default, the docker-compose.yml file is configured to pull the image from Docker Hub. But the container can also be built from scratch with this command:

docker-compose build --no-cache

  • Bring the container online by running the following command:

docker-compose up -d

Usage

The location of the MongoDB data store is specified in the docker-compose.yml file. This makes it easy to backup the data. However, be sure to shut down the docker containers before backing up the data, otherwise it will be fragmented and unusable later.

Docker Debugging

The following commands are useful for debugging applications like this one inside a Docker container. The commands below help you to enter a shell inside the container.

  • docker ps -a

    • Show all docker processes, including ones that are stopped.
  • docker container run --name test-container --rm -it <Image ID> bash

    • This command will run a docker container and drop you into a bash shell. All you need is the image ID.
  • docker exec -it <container ID> bash

    • This command will let you enter a bash shell inside a running Docker container.
You can’t perform that action at this time.