From b219376d4fff0c969b7e5aa56778bf864c17bcc8 Mon Sep 17 00:00:00 2001
From: nick avlo <avlo@yahoo.com>
Date: Mon, 16 Dec 2024 16:30:20 -0700
Subject: [PATCH] added ws\/wss configuration instructions

---
 DEVELOPMENT.md | 32 ++++++++++++++++++++++++++++++++
 README.md      |  9 ++++++---
 2 files changed, 38 insertions(+), 3 deletions(-)

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 502b8ea..497a60c 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -64,6 +64,27 @@ _note: below [java22 nostr-java variant](https://github.com/avlo/nostr-java-avlo
 
 ----
 
+### JUnit / SpringBootTest Superconductor
+##### Two test modes, configurable via [appication-test.properties](src/test/resources/application-test.properties) file
+##### 1. Secure (WSS/TLS) tests mode (default setting)
+```
+# wss autoconfigure
+# secure test (wss) enabled 'true' by default.  for non-secure (ws), change below value to 'false' and...
+server.ssl.enabled=true                                            <--------  "true" for wss/tls
+# ...also for non-secure (ws), change below value to 'ws'...
+superconductor.relay.url=wss://localhost:5555                      <--------  "wss" protocol for wss/tls 
+```
+
+#### 2. Non-Secure (WS) tests mode
+```
+# wss autoconfigure
+# secure test (wss) enabled 'true' by default.  for non-secure (ws), change below value to 'false' and...
+server.ssl.enabled=false                                           <--------  "false" for ws/non-secure
+# ...also for non-secure (ws), change below value to 'ws'...
+superconductor.relay.url=ws://localhost:5555                       <--------  "ws" protocol for ws/non-secure 
+```
+----
+
 ### Run SuperConductor (4 options)
 
 #### 1.  Docker + Docker Compose
@@ -118,7 +139,18 @@ for full/debug developer console logging:
 ----
 
 ### Relay Endpoint for clients
+#### Two modes
+##### 1. Secure (WSS/TLS) mode (default)
+wss://localhost:5555
 
+#### 2. Non-Secure (WS) mode, configurable via _application-**\<env>**.properties_ file (for example, in [appication-local.properties](src/main/resources/application-local.properties))
+```
+# wss autoconfigure
+# secure test (wss) enabled 'true' by default.  for non-secure (ws), change below value to 'false' and...
+server.ssl.enabled=false                                           <--------  "false" for ws/non-secure
+# ...also for non-secure (ws), change below value to 'ws'...
+superconductor.relay.url=ws://localhost:5555                       <--------  "ws" protocol for ws/non-secure 
+```
 ws://localhost:5555
 
 <hr style="border:2px solid grey">
diff --git a/README.md b/README.md
index 6997f97..0ee56cd 100644
--- a/README.md
+++ b/README.md
@@ -79,9 +79,12 @@
 ----
 
 #### Run SuperConductor
-    $ docker compose -f /<path>/<to>/docker-compose-prod.yml up -d
 
-Superconductor is now ready to use.
+$ docker compose -f /<path>/<to>/docker-compose-prod.yml up -d
+
+Superconductor is now ready to use.  
+
+_note: SuperConductor runs in secure (WSS/TLS) mode by default_
 
 ----
 
@@ -93,4 +96,4 @@ Superconductor is now ready to use.
 
 <hr style="border:2px solid grey">
 
-#### [Development Mode Instructions](DEVELOPMENT.md)
\ No newline at end of file
+#### [Development Mode Instructions](DEVELOPMENT.md)