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

Java Nostr-Relay Framework & Web Application

---

Normal/Production Mode Instructions:

Confirm docker requirements

$ docker --version

Docker version 27.5.0

$ docker compose version

Docker Compose version v2.32.4

(Download links for the above)

• Docker 27.5.0
• Docker Compose v2.32.4

(note: Confirmed compatible with Docker 27.0.3 and Docker Compose version v2.28.1 or higher. Earlier versions are at the liability of the developer/administrator)

---

Download Superconductor Docker Image from hub.docker

$ docker pull avlo/superconductor:1.11.0

---

Configure SuperConductor security level, 3 options:

Highest | SSL Certificate (WSS/HTTPS)

• Obtain an SSL certificate
• Install the certificate
• Download application-prod_wss.properties file & configure SSL settings
• Download docker-compose-prod_wss.yml file (and optionally edit relevant parameters as applicable)

Medium | Self-Signed Certificate (WSS/HTTPS)

• Create a Self-Signed Certificate
• Install the certificate
• Download application-prod_wss.properties file & configure SSL settings
• Download docker-compose-prod_wss.yml file (and optionally edit relevant parameters as applicable)

Lowest | Non-secure / Non-encrypted (WS/HTTP)

• Security-related configuration(s) not required
• Download docker-compose-prod_ws.yml file (and optionally edit relevant parameters as applicable)

---

Run SuperConductor

WSS/HTTPS

run without logging:

docker compose -f docker-compose-prod_wss.yml up 

run with container logging displayed to console:

docker compose -f docker-compose-prod_wss.yml up --abort-on-container-failure --attach-dependencies

run with docker logging displayed to console:

docker compose -f docker-compose-prod_wss.yml up -d && dcls | grep 'superconductor-app' | awk '{print $1}' | xargs docker logs -f

WS/HTTP

run without logging:

docker compose -f docker-compose-prod_ws.yml up 

run with container logging displayed to console:

docker compose -f docker-compose-prod_ws.yml up --abort-on-container-failure --attach-dependencies

run with docker logging displayed to console:

docker compose -f docker-compose-prod_ws.yml up -d && dcls | grep 'superconductor-app' | awk '{print $1}' | xargs docker logs -f

---

Stop SuperConductor

WSS/HTTPS

docker compose -f docker-compose-prod_wss.yml stop superconductor superconductor-db

WS/HTTP

docker compose -f docker-compose-prod_ws.yml stop superconductor superconductor-db

---

Remove SuperConductor docker containers

WSS/HTTPS

docker compose -f docker-compose-prod_wss.yml down --remove-orphans

WS/HTTP

docker compose -f docker-compose-prod_ws.yml down --remove-orphans

---

Development Mode Instructions