updated Documentation to reflect new changes

Author: CodeShellDev

.github/templates/README.template.md

@@ -80,10 +80,10 @@ Notice the `@` infront of `authorization`. See [KeyValue Pair Injection](#keyval
 
 ### Example
 
-To send a message to 1234567:
+To send a message to `+123400002`:
 
 ```bash
-curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer API_TOKEN" -d '{"message": "Hello World!", "recipients": ["1234567"]}' http://sec-signal-api:8880/v2/send
+curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer API_TOKEN" -d '{"message": "Hello World!", "recipients": ["+123400002"]}' http://sec-signal-api:8880/v2/send
 ```
 
 ### Advanced
@@ -160,10 +160,10 @@ Suppose you want to set a new [Placeholder](#placeholders) `NUMBER` in your Envi
 
 ```yaml
 environment:
-  VARIABLES__NUMBER: "000"
+  SETTINGS__VARIABLES__NUMBER: "+123400001"
 ```
 
-This would internally be converted into `variables.number` matching the config formatting.
+This would internally be converted into `settings.variables.number` matching the config formatting.
 
 > [!IMPORTANT]
 > Underscores `_` are removed during Conversion, Double Underscores `__` on the other hand convert the Variable into a nested Object (`__` replaced by `.`)
@@ -200,19 +200,15 @@ api:
 ```
 
 > [!IMPORTANT]
-> It is highly recommended use API Tokens
-
-> _What if I just don't?_
-
-Secured Signal API will still work, but important Security Features won't be available
-like Blocked Endpoints and any sort of Auth.
+> Using API Tokens is highly recommended, but not mandatory.
+> Some important Security Features won't be available (like default Blocked Endpoints).
 
 > [!NOTE]
 > Blocked Endpoints can be reactivated by manually configuring them
 
 ### Endpoints
 
-Because Secured Signal API is just a Proxy you can use all of the [Signal REST API](https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/EXAMPLES.md) endpoints except for...
+Since Secured Signal API is just a Proxy you can use all of the [Signal REST API](https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/EXAMPLES.md) endpoints except for...
 
 | Endpoint              |                    |
 | :-------------------- | ------------------ |
@@ -221,27 +217,31 @@ Because Secured Signal API is just a Proxy you can use all of the [Signal REST A
 | **/v1/devives**       | **/v1/contacts**   |
 | **/v1/register**      | **/v1/accounts**   |
 
+These Endpoints are blocked by default due to Security Risks.
+
 > [!NOTE]
-> Matching works by checking if the requested Endpoints startswith a Blocked or Allowed Endpoint
+> Matching works by checking if the requested Endpoints starts with a Blocked or an Allowed Endpoint
 
-These Endpoints are blocked by default due to Security Risks, but can be modified by setting `blockedEndpoints` in your config:
+You can modify Blocked Endpoints by configuring `blockedEndpoints` in your config:
 
 ```yaml
-blockedEndpoints: [/v1/register, /v1/unregister, /v1/qrcodelink, /v1/contacts]
+settings:
+  blockedEndpoints: [/v1/register, /v1/unregister, /v1/qrcodelink, /v1/contacts]
 ```
 
-Override Blocked Endpoints by explicitly allowing endpoints in `allowedEndpoints`.
+You can also override Blocked Endpoints by adding Allowed Endpoints to `allowedEndpoints`.
+
+```yaml
+settings:
+  allowedEndpoints: [/v2/send]
+```
 
 | Config (Allow)                   | (Block)                             |   Result   |     |                   |     |
 | :------------------------------- | :---------------------------------- | :--------: | --- | :---------------: | --- |
 | `allowedEndpoints: ["/v2/send"]` | `unset`                             |  **all**   | 🛑  |  **`/v2/send`**   | ✅  |
 | `unset`                          | `blockedEndpoints: ["/v1/receive"]` |  **all**   | ✅  | **`/v1/receive`** | 🛑  |
 | `blockedEndpoints: ["/v2"]`      | `allowedEndpoints: ["/v2/send"]`    | **`/v2*`** | 🛑  |  **`/v2/send`**   | ✅  |
 
-```yaml
-allowedEndpoints: [/v2/send]
-```
-
 ### Variables
 
 Placeholders can be added under `variables` and can then be referenced in the Body, Query or URL.
@@ -252,11 +252,10 @@ See [Placeholders](#placeholders).
 > Example: `number` becomes `NUMBER` in `{{.NUMBER}}`
 
 ```yaml
-variables:
-  number: "001",
-  recipients: [
-    "user.id", "000", "001", "group.id"
-  ]
+settings:
+  variables:
+    number: "+123400001",
+    recipients: ["+123400002", "group.id", "user.id"]
 ```
 
 ### Message Aliases
@@ -278,12 +277,13 @@ Secured Signal API will pick the best scoring Message Alias (if available) to ex
 Message Aliases can be added by setting `messageAliases` in your config:
 
 ```yaml
-messageAliases:
-  [
-    { alias: "msg", score: 80 },
-    { alias: "data.message", score: 79 },
-    { alias: "array[0].message", score: 78 },
-  ]
+settings:
+  messageAliases:
+    [
+      { alias: "msg", score: 80 },
+      { alias: "data.message", score: 79 },
+      { alias: "array[0].message", score: 78 },
+    ]
 ```
 
 ### Port

config/defaults.yml

@@ -1,7 +1,7 @@
 server:
   port: 8880
 
-logLevel: INFO
+logLevel: info
 
 settings:
   messageAliases:

docker-compose.yaml

@@ -6,27 +6,28 @@ services:
       - MODE=normal
     volumes:
       - ./data:/home/.local/share/signal-cli
+    restart: unless-stopped
     networks:
       backend:
         aliases:
           - signal-api
-    restart: unless-stopped
 
   secured-signal:
     image: ghcr.io/codeshelldev/secured-signal-api:latest
     container_name: secured-signal
-    networks:
-      backend:
-        aliases:
-          - secured-signal-api
     environment:
       API__URL: http://signal-api:8080
-      VARIABLES__RECIPIENTS: 000,001,002
-      VARIABLES__NUMBER: 123456789
-      API__TOKENS: LOOOOOONG_STRING
+      SETTINGS__VARIABLES__RECIPIENTS:
+        ["+123400002", "+123400003", "+123400004"]
+      SETTINGS__VARIABLES__NUMBER: "+123400001"
+      API__TOKENS: [LOOOOOONG_STRING]
     ports:
       - "8880:8880"
     restart: unless-stopped
+    networks:
+      backend:
+        aliases:
+          - secured-signal-api
 
 networks:
   backend:

examples/config.yml

@@ -9,8 +9,8 @@ logLevel: INFO
 
 settings:
   variables:
-    number: "000"
-    recipients: ["001", "group.id", "user.id"]
+    number: "+123400001"
+    recipients: ["+123400002", "group.id", "user.id"]
 
   messageAliases: [{ alias: "msg", score: 100 }]
 

examples/traefik.docker-compose.yaml

@@ -2,16 +2,11 @@ services:
   secured-signal:
     image: ghcr.io/codeshelldev/secured-signal-api:latest
     container_name: secured-signal
-    networks:
-      proxy:
-      backend:
-        aliases:
-          - secured-signal-api
     environment:
       API__URL: http://signal-api:8080
-      DEFAULT_RECIPIENTS: 000,001,002
-      NUMBER: 123456789
-      API__TOKENS: LOOOOOONG_STRING
+      SETTINGS__VARIABLES__RECIPIENTS: ["123400002", "123400003", "123400004"]
+      SETTINGS__VARIABLES__NUMBER: "+123400001"
+      API__TOKENS: [LOOOOOONG_STRING]
     labels:
       - traefik.enable=true
       - traefik.http.routers.signal-api.rule=Host(`signal-api.mydomain.com`)
@@ -22,6 +17,11 @@ services:
       - traefik.http.services.signal-api-svc.loadbalancer.server.port=8880
       - traefik.docker.network=proxy
     restart: unless-stopped
+    networks:
+      proxy:
+      backend:
+        aliases:
+          - secured-signal-api
 
 networks:
   backend:

utils/config/loader.go

@@ -48,20 +48,6 @@ var ENV *ENV_ = &ENV_{
 	INSECURE: false,
 }
 
-func InitEnv() {
-	ENV.PORT = strconv.Itoa(config.Int("server.port"))
-
-	ENV.LOG_LEVEL = config.String("loglevel")
-	
-	ENV.API_URL = config.String("api.url")
-
-	transformChildren(config, "variables", func(key string, value any) (string, any) {
-		return strings.ToUpper(key), value
-	})
-
-	config.Unmarshal("settings", ENV.SETTINGS["*"])
-}
-
 func Load() {
 	LoadDefaults()
 
@@ -86,6 +72,20 @@ func Load() {
 	log.Dev("Loaded Token Configs:\n" + utils.ToJson(tokensLayer.All()))
 }
 
+func InitEnv() {
+	ENV.PORT = strconv.Itoa(config.Int("server.port"))
+
+	ENV.LOG_LEVEL = config.String("loglevel")
+	
+	ENV.API_URL = config.String("api.url")
+
+	transformChildren(config, "variables", func(key string, value any) (string, any) {
+		return strings.ToUpper(key), value
+	})
+
+	config.Unmarshal("settings", ENV.SETTINGS["*"])
+}
+
 func LoadDefaults() {
 	_, defErr := LoadFile(ENV.DEFAULTS_PATH, defaultsLayer, yaml.Parser())