Java Nostr-Relay, Relay Framework & WebSocket Application Server

 .::::::.  ...    :::::::::::::. .,:::::: :::::::..     .,-:::::     ...   :::.    :::.:::::::-.   ...    :::  .,-:::::::::::::::::   ...    :::::::..
;;;`    `  ;;     ;;; `;;;```.;;;;;;;'''' ;;;;``;;;;  ,;;;'````'  .;;;;;;;.`;;;;,  `;;; ;;,   `';, ;;     ;;;,;;;'````';;;;;;;;''''.;;;;;;;. ;;;;``;;;;
'[==/[[[[,[['     [[[  `]]nnn]]'  [[cccc   [[[,/[[['  [[[        ,[[     \[[,[[[[[. '[[ `[[     [[[['     [[[[[[            [[    ,[[     \[[,[[[,/[[['
  '''    $$$      $$$   $$$""     $$""""   $$$$$$c    $$$        $$$,     $$$$$$ "Y$c$$  $$,    $$$$      $$$$$$            $$    $$$,     $$$$$$$$$c
 88b    dP88    .d888   888o      888oo,__ 888b "88bo,`88bo,__,o,"888,_ _,88P888    Y88  888_,o8P'88    .d888`88bo,__,o,    88,   "888,_ _,88P888b "88bo,
  "YMmMY"  "YmmMMMM""   YMMMb     """"YUMMMMMMM   "W"   "YUMMMMMP" "YMMMMMP" MMM     YM  MMMMP"`   "YmmMMMM""  "YUMMMMMP"   MMM     "YMMMMMP" MMMM   "W"

Java Nostr-Relay, Relay Framework & WebSocket Application Server

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

redis

  $ docker pull avlo/superconductor-app-redis:1.16.1

sqlite

  $ docker pull avlo/superconductor-app-sqlite:1.16.1

mysql

  $ docker pull avlo/superconductor-app-mysql:1.16.1

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

WS/HTTP

relay security keys required

redis

run without logging:

$ docker compose -f superconductor/redis/docker-compose-prod_ws.yml up

run with container logging displayed to console:

$ docker compose -f superconductor/redis/docker-compose-prod_ws.yml up --abort-on-container-failure --attach-dependencies

run with docker logging displayed to console:

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

sqlite

run without logging:

$ docker compose -f superconductor/sqlite/docker-compose-prod_ws.yml up

run with container logging displayed to console:

$ docker compose -f superconductor/sqlite/docker-compose-prod_ws.yml up --abort-on-container-failure --attach-dependencies

run with docker logging displayed to console:

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

mysql

run without logging:

$ docker compose -f superconductor/mysql/docker-compose-prod_ws.yml up

run with container logging displayed to console:

$ docker compose -f superconductor/mysql/docker-compose-prod_ws.yml up --abort-on-container-failure --attach-dependencies

run with docker logging displayed to console:

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

WSS/HTTPS

relay security keys required & superconductor/docker-compose-prod_wss.yml parameters as applicable

redis

run without logging:

$ docker compose -f superconductor/redis/docker-compose-prod_wss.yml up

run with container logging displayed to console:

$ docker compose -f superconductor/redis/docker-compose-prod_wss.yml up --abort-on-container-failure --attach-dependencies

run with docker logging displayed to console:

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

sqlite

run without logging:

$ docker compose -f superconductor/sqlite/docker-compose-prod_wss.yml up

run with container logging displayed to console:

$ docker compose -f superconductor/sqlite/docker-compose-prod_wss.yml up --abort-on-container-failure --attach-dependencies

run with docker logging displayed to console:

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

mysql

run without logging:

$ docker compose -f superconductor/mysql/docker-compose-prod_wss.yml up

run with container logging displayed to console:

$ docker compose -f superconductor/mysql/docker-compose-prod_wss.yml up --abort-on-container-failure --attach-dependencies

run with docker logging displayed to console:

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

Stop SuperConductor

WS/HTTP

redis

$ docker compose -f superconductor/redis/docker-compose-prod_ws.yml stop

sqlite

$ docker compose -f superconductor/sqlite/docker-compose-prod_ws.yml stop

mysql

$ docker compose -f superconductor/mysql/docker-compose-prod_ws.yml stop

WSS/HTTPS

redis

$ docker compose -f superconductor/redis/docker-compose-prod_wss.yml stop

sqlite

$ docker compose -f superconductor/sqlite/docker-compose-prod_wss.yml stop

mysql

$ docker compose -f superconductor/mysql/docker-compose-prod_wss.yml stop

Remove SuperConductor docker containers

WS/HTTP

redis

$ docker compose -f superconductor/redis/docker-compose-prod_ws.yml down --remove-orphans

sqlite

$ docker compose -f superconductor/sqlite/docker-compose-prod_ws.yml down --remove-orphans

mysql

$ docker compose -f superconductor/mysql/docker-compose-prod_ws.yml down --remove-orphans

WSS/HTTPS

redis

$ docker compose -f superconductor/redis/docker-compose-prod_wss.yml down --remove-orphans

sqlite

$ docker compose -f superconductor/sqlite/docker-compose-prod_wss.yml down --remove-orphans

mysql

$ docker compose -f superconductor/mysql/docker-compose-prod_wss.yml down --remove-orphans

Name		Name	Last commit message	Last commit date
Latest commit History 843 Commits
.github/workflows		.github/workflows
.mvn/wrapper		.mvn/wrapper
autoconfigure		autoconfigure
base		base
buildSrc		buildSrc
gradle		gradle
lib		lib
starter		starter
superconductor		superconductor
.gitignore		.gitignore
DEVELOPMENT.md		DEVELOPMENT.md
LICENSE		LICENSE
README.md		README.md
autotest.properties		autotest.properties
autotest.sh		autotest.sh
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
mvnw		mvnw
mvnw.cmd		mvnw.cmd
pom.xml		pom.xml
settings.gradle		settings.gradle

License

avlo/superconductor

Folders and files

Latest commit

History

Repository files navigation

Java Nostr-Relay, Relay Framework & WebSocket Application Server

Normal/Production Mode Instructions:

Confirm docker requirements

Download Superconductor Docker Image from hub.docker

Configure SuperConductor security level, 3 options:

Run SuperConductor

relay security keys required

run without logging:

run with container logging displayed to console:

run with docker logging displayed to console:

run without logging:

run with container logging displayed to console:

run with docker logging displayed to console:

run without logging:

run with container logging displayed to console:

run with docker logging displayed to console:

relay security keys required & superconductor/docker-compose-prod_wss.yml parameters as applicable

run without logging:

run with container logging displayed to console:

run with docker logging displayed to console:

run without logging:

run with container logging displayed to console:

run with docker logging displayed to console:

run without logging:

run with container logging displayed to console:

run with docker logging displayed to console:

Stop SuperConductor

Remove SuperConductor docker containers

Development Mode Instructions

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Uh oh!

Languages

Packages