Home

Awesome

███████╗██╗   ██╗██████╗ ███████╗██████╗  ██████╗ ██████╗ ███╗   ██╗██████╗ ██╗   ██╗ ██████╗████████╗ ██████╗ ██████╗
██╔════╝██║   ██║██╔══██╗██╔════╝██╔══██╗██╔════╝██╔═══██╗████╗  ██║██╔══██╗██║   ██║██╔════╝╚══██╔══╝██╔═══██╗██╔══██╗
███████╗██║   ██║██████╔╝█████╗  ██████╔╝██║     ██║   ██║██╔██╗ ██║██║  ██║██║   ██║██║        ██║   ██║   ██║██████╔╝
╚════██║██║   ██║██╔═══╝ ██╔══╝  ██╔══██╗██║     ██║   ██║██║╚██╗██║██║  ██║██║   ██║██║        ██║   ██║   ██║██╔══██╗
███████║╚██████╔╝██║     ███████╗██║  ██║╚██████╗╚██████╔╝██║ ╚████║██████╔╝╚██████╔╝╚██████╗   ██║   ╚██████╔╝██║  ██║
╚══════╝ ╚═════╝ ╚═╝     ╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚═════╝ ╚═╝  ╚═══╝╚═════╝  ╚═════╝  ╚═════╝   ╚═╝    ╚═════╝ ╚═╝  ╚═╝

Java Nostr-Relay Framework & Web Application

Supported Nips

In-Progress


Normal/Production Mode (for most users) Instructions:

Confirm minimal docker requirements

$ docker --version
Docker version 27.0.3
$ docker compose version
Docker Compose version v2.28.1

(Download links for the above)


Download Superconductor Docker Image from hub.docker

$ docker pull avlo/superconductor:1.7.5

Download Docker-Compose configuration file (and optionally edit various parameters as desired):

docker-compose-prod.yml


Run SuperConductor

$ docker compose -f /<path>/<to>/docker-compose-prod.yml up -d

Superconductor is now ready to use.


Stop docker containers
$ docker compose -f docker-compose-prod.yml stop superconductor superconductor-db
Remove docker containers
$ docker compose -f docker-compose-prod.yml down --remove-orphans
<hr style="border:2px solid grey">

Development Mode Instructions