Skip to content

Nostr Relay - Java/Spring/WebSocketSession Implementation

License

Notifications You must be signed in to change notification settings

avlo/superconductor

Repository files navigation

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

Java Nostr-Relay Framework & Web Application

Supported Nips


Normal/Production Mode (for most users) 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)

(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.10.0

Configure SuperConductor security level, 3 options:

Highest | SSL Certificate (WSS/HTTPS)
Medium | Self-Signed Certificate (WSS/HTTPS)
Lowest | Non-secure / Non-encrypted (WS/HTTP)

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

About

Nostr Relay - Java/Spring/WebSocketSession Implementation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published