Merge branch 'main' into feat/message-templates

Author: CodeShellDev

.github/templates/README.template.md

@@ -1,10 +1,10 @@
-<img align="center" width="1048" height="512" alt="Secure Proxy for Signal REST API" src="https://github.com/CodeShellDev/secured-signal-api/raw/refs/heads/main/logo/landscape" />
+<img align="center" width="1048" height="512" alt="Secure Proxy for Signal REST API" src="https://github.com/CodeShellDev/secured-signal-api/raw/refs/heads/main/logo/banner.png" />
 
 <h3 align="center">Secure Proxy for <a href="https://github.com/bbernhard/signal-cli-rest-api">Signal Messenger REST API</a></h3>
 
 <p align="center">
-Adding token-based authentication,
-endpoint restrictions, placeholders, and flexible configuration.
+token-based authentication,
+endpoint restrictions, placeholders, flexible configuration
 </p>
 
 <p align="center">
@@ -125,11 +125,11 @@ If you are not comfortable / don't want to hardcode your Number for example and/
 
 You can use [**Variable**](#variables) `{{.NUMBER}}` Placeholders and **Body** Placeholders `{{@data.key}}`.
 
-| Type | Example |
-| :--- | :------ |
-| Body | `{"number": "{{ .NUMBER }}", "recipients": "{{ .RECIPIENTS }}"}` |
-| Query| `http://sec-signal-api:8880/v1/receive/?@number={{.NUMBER}}` |
-| Path | `http://sec-signal-api:8880/v1/receive/{{.NUMBER}}` |
+| Type  | Example                                                          |
+| :---- | :--------------------------------------------------------------- |
+| Body  | `{"number": "{{ .NUMBER }}", "recipients": "{{ .RECIPIENTS }}"}` |
+| Query | `http://sec-signal-api:8880/v1/receive/?@number={{.NUMBER}}`     |
+| Path  | `http://sec-signal-api:8880/v1/receive/{{.NUMBER}}`              |
 
 You can also combine them:
 
@@ -335,10 +335,7 @@ settings:
         { alias: "data.message", score: 79 },
         { alias: "array[0].message", score: 78 },
       ]
-    ".NUMBER":
-      [
-        { alias: "phone_number", score: 100 },
-      ]
+    ".NUMBER": [{ alias: "phone_number", score: 100 }]
 ```
 
 Use `@` for aliasing Body Keys and `.` for aliasing Variables.
@@ -363,19 +360,26 @@ To change the Log Level set `logLevel` to: (default: `info`)
 | `fatal` |
 | `dev`   |
 
-</details>
+</details
 
 ## Contributing
 
 Found a bug? Want to change or add something?
-Feel free to open up an issue or create a Pull Request!
+Feel free to open up an [Issue](https://github.com/codeshelldev/secured-signal-api/issues) or create a [Pull Request](https://github.com/codeshelldev/secured-signal-api/pulls)!
 
 ## Support
 
 Has this Repo been helpful 👍️ to you? Then consider ⭐️'ing this Project.
 
 :)
 
+## Help
+
+**Are you having Problems setting up Secured Signal API?**<br>
+No worries check out the [Discussions](https://github.com/codeshelldev/secured-signal-api/discussions) Tab and ask for help.
+
+**We are all Volunteers**, so please be friendly and patient.
+
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)

Dockerfile

@@ -1,9 +1,14 @@
 FROM alpine:latest
 RUN apk --no-cache add ca-certificates
 
-ENV SERVER__PORT=8880
+ARG IMAGE_TAG
+ENV IMAGE_TAG=$IMAGE_TAG
+LABEL org.opencontainers.image.version=$IMAGE_TAG
 
-ENV DEFAULTS_PATH=/app/config/defaults.yml
+ENV SERVICE__PORT=8880
+
+ENV DEFAULTS_PATH=/app/data/defaults.yml
+ENV FAVICON_PATH=/app/data/favicon.ico
 
 ENV CONFIG_PATH=/config/config.yml
 ENV TOKENS_DIR=/config/tokens

README.md

@@ -1,10 +1,10 @@
-<img align="center" width="1048" height="512" alt="Secure Proxy for Signal REST API" src="https://github.com/CodeShellDev/secured-signal-api/raw/refs/heads/main/logo/landscape" />
+<img align="center" width="1048" height="512" alt="Secure Proxy for Signal REST API" src="https://github.com/CodeShellDev/secured-signal-api/raw/refs/heads/main/logo/banner.png" />
 
 <h3 align="center">Secure Proxy for <a href="https://github.com/bbernhard/signal-cli-rest-api">Signal Messenger REST API</a></h3>
 
 <p align="center">
 token-based authentication,
-endpoint restrictions, placeholders, and flexible configuration.
+endpoint restrictions, placeholders, flexible configuration
 </p>
 
 <p align="center">
@@ -457,19 +457,26 @@ To change the Log Level set `logLevel` to: (default: `info`)
 | `fatal` |
 | `dev`   |
 
-</details>
+</details
 
 ## Contributing
 
 Found a bug? Want to change or add something?
-Feel free to open up an issue or create a Pull Request!
+Feel free to open up an [Issue](https://github.com/codeshelldev/secured-signal-api/issues) or create a [Pull Request](https://github.com/codeshelldev/secured-signal-api/pulls)!
 
 ## Support
 
 Has this Repo been helpful 👍️ to you? Then consider ⭐️'ing this Project.
 
 :)
 
+## Help
+
+**Are you having Problems setting up Secured Signal API?**<br>
+No worries check out the [Discussions](https://github.com/codeshelldev/secured-signal-api/discussions) Tab and ask for help.
+
+**We are all Volunteers**, so please be friendly and patient.
+
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)

config/defaults.yml renamed to data/defaults.yml

@@ -0,0 +1,23 @@
+package middlewares
+
+import (
+	"net/http"
+
+	"github.com/codeshelldev/secured-signal-api/utils/config"
+)
+
+type ServeMiddleware struct {
+	Next http.Handler
+}
+
+func (data ServeMiddleware) Use() http.Handler {
+	mux := http.NewServeMux()
+
+	mux.HandleFunc("/favicon.ico", func(w http.ResponseWriter, req *http.Request) {
+		http.ServeFile(w, req, config.ENV.FAVICON_PATH)
+	})
+
+	mux.Handle("/", data.Next)
+
+	return mux
+}

data/favicon.ico

@@ -11,4 +11,4 @@ func Create(targetUrl string) *httputil.ReverseProxy {
 	proxy := httputil.NewSingleHostReverseProxy(url)
 
 	return proxy
-}
+}

internals/proxy/middlewares/server.go

@@ -12,7 +12,7 @@ import (
 	log "github.com/codeshelldev/secured-signal-api/utils/logger"
 )
 
-var initHandler *httputil.ReverseProxy
+var proxy_last *httputil.ReverseProxy
 
 var ENV *config.ENV_
 
@@ -31,33 +31,37 @@ func main() {
 
 	log.Info("Initialized Logger with Level of ", log.Level())
 
-	initHandler = proxy.Create(ENV.API_URL)
+	proxy_last = proxy.Create(ENV.API_URL)
 
-	mesg_m5 := middlewares.MessageMiddleware{
-		Next: 	initHandler,
+	mesg_m6 := middlewares.MessageMiddleware{
+		Next: 	proxy_last,
 	}
 
-	alias_m4 := middlewares.AliasMiddleware{
-		Next: 	mesg_m5.Use(),
+	alias_m5 := middlewares.AliasMiddleware{
+		Next: 	mesg_m6.Use(),
 	}
 
-	temp_m3 := middlewares.TemplateMiddleware{
-		Next: 	alias_m4.Use(),
+	temp_m4 := middlewares.TemplateMiddleware{
+		Next: 	alias_m5.Use(),
 	}
 
-	endp_m2 := middlewares.EndpointsMiddleware{
-		Next: 	temp_m3.Use(),
+	endp_m3 := middlewares.EndpointsMiddleware{
+		Next: 	temp_m4.Use(),
 	}
 
-	auth_m1 := middlewares.AuthMiddleware{
-		Next:   endp_m2.Use(),
+	auth_m2 := middlewares.AuthMiddleware{
+		Next:   endp_m3.Use(),
+	}
+
+	serv_m1 := middlewares.ServeMiddleware{
+		Next: auth_m2.Use(),
 	}
 
 	log_m0 := middlewares.LogMiddleware{
-		Next: 	auth_m1.Use(),
+		Next: 	serv_m1.Use(),
 	}
 
-	log.Info("Initialized Proxy Handler")
+	log.Info("Initialized Middlewares")
 
 	addr := "0.0.0.0:" + ENV.PORT
 

internals/proxy/proxy.go

@@ -17,6 +17,7 @@ import (
 type ENV_ struct {
 	CONFIG_PATH			string
 	DEFAULTS_PATH		string
+	FAVICON_PATH		string
 	TOKENS_DIR			string
 	LOG_LEVEL			string
 	PORT 				string
@@ -38,6 +39,7 @@ var ENV *ENV_ = &ENV_{
 	CONFIG_PATH: os.Getenv("CONFIG_PATH"),
 	DEFAULTS_PATH: os.Getenv("DEFAULTS_PATH"),
 	TOKENS_DIR: os.Getenv("TOKENS_DIR"),
+	FAVICON_PATH: os.Getenv("FAVICON_PATH"),
 	API_TOKENS: []string{},
 	SETTINGS: map[string]*SETTING_{