Sign inSign up

supertypo/kaspa-rest-server

By supertypo

•Updated about 2 years ago

Docker images of Kaspa Rest Server.

Image
0

10K+

supertypo/kaspa-rest-server repository overview

⁠DEPRECATION NOTICE

This repository is deprecated, new releases can be found here:

⁠https://hub.docker.com/r/kaspanet/kaspa-rest-server⁠

⁠Legacy documentation

Docker images of Kaspa Rest Server.
https://github.com/lAmeR1/kaspa-rest-server⁠

⁠Usage

Se example compose-file examples below.
Create a file named 'docker-compose-yaml' and paste the selected compose-file content into it ("full" or "light", see below).
Run with 'docker-compose up -d'
Note: Kaspad (the kaspa node) will use at least 30 minutes to fully sync (longer on slower hardware / network connection).

⁠"Full stack" Kaspa REST + WebSocket API.

Includes a database and the db-filler for persistence.
This setup will retain the full block and transaction history from the point in time it is started.
If you also want the Kaspa Explorer (for verification or otherwise) - look over here: https://hub.docker.com/r/supertypo/kaspa-explorer⁠

version: "3"

services:
  kaspa_rest_server:
    image: supertypo/kaspa-rest-server:latest
    restart: unless-stopped
    environment:
      KASPAD_HOST_1: kaspad:16110
      SQL_URI: postgresql+asyncpg://postgres:mysecretpassword@kaspa_db:5432/postgres
    ports:
      - "8000:8000/tcp"
    links:
      - kaspad
      - kaspa_db

  kaspa_socket_server:
    image: lamer1/kaspa-socket-server:latest
    restart: unless-stopped
    environment:
      KASPAD_HOST_1: kaspad:16110
      SQL_URI: postgresql+asyncpg://postgres:mysecretpassword@kaspa_db:5432/postgres
    ports:
      - "8001:8000/tcp"
    links:
      - kaspad
      - kaspa_db

  kaspa_db_filler:
    image: supertypo/kaspa-db-filler:latest
    restart: unless-stopped
    environment:
      DEBUG: "true"
      KASPAD_HOST_1: kaspad:16110
      SQL_URI: postgresql://postgres:mysecretpassword@kaspa_db:5432/postgres
    links:
      - kaspad
      - kaspa_db

  kaspad:
    image: supertypo/kaspad:latest
    restart: unless-stopped
    ports:
      - "16110:16110/tcp" # RPC - consider removing
      - "16111:16111/tcp"
    volumes:
      - kaspad:/app/data/

  kaspa_db:
    image: postgres:14-alpine
    restart: unless-stopped
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: mysecretpassword
      POSTGRES_DB: postgres
    ports:
      - "5432:5432/tcp"
    volumes:
      - kaspa_db:/var/lib/postgresql/data/

volumes:
  kaspad:
  kaspa_db:

⁠NOT SUPPORTED YET: "Light" Kaspa REST + WebSocket API.

This setup will NOT retain the full block and transaction history from the point in time it is started.

version: "3"

services:

  kaspa_rest_server:
    image: supertypo/kaspa-rest-server:latest
    restart: unless-stopped
    environment:
      KASPAD_HOST_1: kaspad:16110
    ports:
      - "8000:8000/tcp"
    links:
      - kaspad

  kaspa_socket_server:
    image: lamer1/kaspa-socket-server:latest
    restart: unless-stopped
    environment:
      KASPAD_HOST_1: kaspad:16110
    ports:
      - "8001:8000/tcp"
    links:
      - kaspad

  kaspad:
    image: supertypo/kaspad:latest
    restart: unless-stopped
    ports:
      - "16110:16110/tcp" # RPC - consider removing
      - "16111:16111/tcp"
    volumes:
      - kaspad:/app/data/

volumes:
  kaspad:

⁠Donations welcome

If you appreciate the Docker images and guides I create and maintain for the community, please consider a donation: kaspa:qrjtsnnpjyvlmkffdqyayrny3qyen9yjkpuw7xvhsz36n69wmrfdyf3nwv67t

Tag summary

Content type

Image

Digest

sha256:99403aff0…

Size

184.7 MB

Last updated

about 2 years ago

docker pull supertypo/kaspa-rest-server