Skip to content

Commit c5e017c

Browse files
Update README.md
1 parent bfa8f92 commit c5e017c

File tree

1 file changed

+37
-25
lines changed

1 file changed

+37
-25
lines changed

README.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,12 @@ To use Basic Auth as Authorization Method add `Authorization: Basic BASE64_STRIN
114114

115115
User is `api` (LOWERCASE)
116116

117-
Formatting for `BASE64_STRING` = `user:API_KEY`.
117+
Formatting for `BASE64_STRING` = `user:API_TOKEN`.
118118

119119
example:
120120

121121
```bash
122-
echo "api:API_KEY" | base64
122+
echo "api:API_TOKEN" | base64
123123
```
124124

125125
=> `YXBpOkFQSV9LRVkK`
@@ -135,7 +135,7 @@ Here is a simple example:
135135
curl -X POST http://sec-signal-api:8880/v2/send?@authorization=API_TOKEN
136136
```
137137

138-
Notice the `@` infront of `authorization`. See [Formatting](#format)
138+
Notice the `@` infront of `authorization`. See [Formatting](#format).
139139

140140
### Example
141141

@@ -180,9 +180,17 @@ http://sec-signal-api:8880/v1/receive/{{.NUMBER}}
180180
181181
In some cases you may not be able to access / modify the Request Body, in that case specify needed values in the Request Query:
182182
183-
```
184-
http://sec-signal-api:8880/?@key=value
185-
```
183+
Supported types include **strings**, **ints** and **arrays**
184+
185+
`http://sec-signal-api:8880/?@key=value`
186+
187+
| type | example |
188+
| :--------- | :------ |
189+
| string | abc |
190+
| int | 123 |
191+
| array | [1,2,3] |
192+
| array(int) | 1,2,3 |
193+
| array(str) | a,b,c |
186194
187195
##### Format
188196
@@ -191,38 +199,42 @@ you have to add `@` in front of any KeyValue Pair assignment.
191199
192200
### Environment Variables
193201
194-
#### API Token
202+
#### API Token/s
203+
204+
Both `API_TOKEN` and `API_TOKENS` support multiple Tokens seperated by **,**.
205+
During Authentikcation Secured Signal API will try to match the given Token against the list of Tokens inside of these Variables.
206+
207+
```yaml
208+
environment:
209+
API_TOKEN: "token1, token2, token3"
210+
API_TOKENS: "token1, token2, token3"
211+
```
195212

196213
> [!IMPORTANT]
197214
> It is highly recommended to set this Environment Variable
198215
199216
> _What if I just don't?_
200217
201-
Well, Secured Signal API will still work, but important Security Features won't be available
218+
Secured Signal API will still work, but important Security Features won't be available
202219
like Blocked Endpoints and any sort of Auth.
203220

204221
> [!NOTE]
205222
> Blocked Endpoints can be reactivated by manually setting them in the Environment
206223
207224
#### Blocked Endpoints
208225

209-
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 except for...
210-
211-
- **/v1/about**
212-
213-
- **/v1/configuration**
214-
215-
- **/v1/devices**
216-
217-
- **/v1/register**
218-
219-
- **/v1/unregister**
220-
221-
- **/v1/qrcodelink**
222-
223-
- **/v1/accounts**
224-
225-
- **/v1/contacts**
226+
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...
227+
228+
| Endpoint |
229+
| :-------------------- |
230+
| **/v1/about** |
231+
| **/v1/configuration** |
232+
| **/v1/devives** |
233+
| **/v1/register** |
234+
| **/v1/unregister** |
235+
| **/v1/qrcodelink** |
236+
| **/v1/accounts** |
237+
| **/v1/contacts** |
226238

227239
These Endpoints are blocked by default due to Security Risks, but can be modified by setting `BLOCKED_ENDPOINTS` to a valid json array string
228240

0 commit comments

Comments
 (0)