Merge branch 'main' of https://github.com/CodeShellDev/secured-signal-api

Author: CodeShellDev

README.md

@@ -9,20 +9,97 @@ Get the latest version of the `docker-compose.yaml` file:
 ```yaml
 ---
 services:
-  myservice:
-    container_name: myservice
+  signal-api:
+    image: bbernhard/signal-cli-rest-api
+    container_name: signal-api
+    environment:
+      - MODE=normal
+    volumes:
+      - ./data:/home/.local/share/signal-cli
+    networks:
+      backend:
+        aliases:
+          - signal-api
+    restart: unless-stopped
+
+  secured-signal:
+    image: ghcr.io/codeshelldev/secured-signal-api
+    container_name: secured-signal
+    networks:
+      backend:
+        aliases:
+          - secured-signal-api
+    environment:
+      SIGNAL_API_URL: http://signal-api:8080
+      DEFAULT_RECIPIENTS: '[ "000", "001", "002" ]'
+      SENDER: 123456789
+    ports:
+      - "8880:8880"
+    restart: unless-stopped
+
+networks:
+  backend:
+```
+
+### Reverse proxy
+
+Take a look at traefik implementation:
+
+```yaml
+{ { file.example/traefik.docker-compose.yaml } }
 ```
 
+## Setup
+
+Before you can send messages via `secured-signal-api` you must first setup [`signal-api`](https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/EXAMPLES.md),
+
+to send messages you have to either:
+
+- register a Signal Account
+
+OR
+
+- link Signal Api to a already registered Signal Device
+
 ## Usage
 
 To send a message to `number`: `1234567`:
 
 ```bash
-curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer TOKEN" -d '{"message": "Hello World!", "recipients": ["1234567"]}' http://signal-api/v2/send
+curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer TOKEN" -d '{"message": "Hello World!", "recipients": ["1234567"]}' http://signal-api:8880/v2/send
+```
+
+### Configuration
+
+Because `secured-signal-api` is just a secure proxy you can use all of the [Signal REST Api](https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/EXAMPLES.md) endpoints with an Exception of:
+
+```python
+DEFAULT_BLOCKED_ENDPOINTS = [
+    "/v1/about",
+    "/v1/configuration",
+    "/v1/devices",
+    "/v1/register",
+    "/v1/unregister",
+    "/v1/qrcodelink",
+    "/v1/accounts",
+    "/v1/contacts"
+]
+```
+
+Which are blocked by default to increase Security, but you these can be modified by setting the `BLOCKED_ENDPOINTS` environment variable as a valid json array
+
+```yaml
+environment:
+  BLOCKED_ENDPOINTS: '[ "/v1/register","/v1/unregister","/v1/qrcodelink","/v1/contacts" ]'
 ```
 
 ## Contributing
 
+Found a bug? Want to change or add something?
+Feel free to open up an issue or create a Pull Request!
+
+_This is a small project so don't expect any huge changes in the future_
+
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)