Skip to content

Commit bfa8f92

Browse files
committed
updated README to reflect changes
1 parent e09033c commit bfa8f92

File tree

1 file changed

+37
-25
lines changed

1 file changed

+37
-25
lines changed

.github/templates/README.template.md

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

5656
User is `api` (LOWERCASE)
5757

58-
Formatting for `BASE64_STRING` = `user:API_KEY`.
58+
Formatting for `BASE64_STRING` = `user:API_TOKEN`.
5959

6060
example:
6161

6262
```bash
63-
echo "api:API_KEY" | base64
63+
echo "api:API_TOKEN" | base64
6464
```
6565

6666
=> `YXBpOkFQSV9LRVkK`
@@ -76,7 +76,7 @@ Here is a simple example:
7676
curl -X POST http://sec-signal-api:8880/v2/send?@authorization=API_TOKEN
7777
```
7878

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

8181
### Example
8282

@@ -121,9 +121,17 @@ http://sec-signal-api:8880/v1/receive/{{.NUMBER}}
121121

122122
In some cases you may not be able to access / modify the Request Body, in that case specify needed values in the Request Query:
123123

124-
```
125-
http://sec-signal-api:8880/?@key=value
126-
```
124+
Supported types include **strings**, **ints** and **arrays**
125+
126+
`http://sec-signal-api:8880/?@key=value`
127+
128+
| type | example |
129+
| :--------- | :------ |
130+
| string | abc |
131+
| int | 123 |
132+
| array | [1,2,3] |
133+
| array(int) | 1,2,3 |
134+
| array(str) | a,b,c |
127135

128136
##### Format
129137

@@ -132,38 +140,42 @@ you have to add `@` in front of any KeyValue Pair assignment.
132140

133141
### Environment Variables
134142

135-
#### API Token
143+
#### API Token/s
144+
145+
Both `API_TOKEN` and `API_TOKENS` support multiple Tokens seperated by **,**.
146+
During Authentikcation Secured Signal API will try to match the given Token against the list of Tokens inside of these Variables.
147+
148+
```yaml
149+
environment:
150+
API_TOKEN: "token1, token2, token3"
151+
API_TOKENS: "token1, token2, token3"
152+
```
136153
137154
> [!IMPORTANT]
138155
> It is highly recommended to set this Environment Variable
139156
140157
> _What if I just don't?_
141158
142-
Well, Secured Signal API will still work, but important Security Features won't be available
159+
Secured Signal API will still work, but important Security Features won't be available
143160
like Blocked Endpoints and any sort of Auth.
144161
145162
> [!NOTE]
146163
> Blocked Endpoints can be reactivated by manually setting them in the Environment
147164
148165
#### Blocked Endpoints
149166
150-
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...
151-
152-
- **/v1/about**
153-
154-
- **/v1/configuration**
155-
156-
- **/v1/devices**
157-
158-
- **/v1/register**
159-
160-
- **/v1/unregister**
161-
162-
- **/v1/qrcodelink**
163-
164-
- **/v1/accounts**
165-
166-
- **/v1/contacts**
167+
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...
168+
169+
| Endpoint |
170+
| :-------------------- |
171+
| **/v1/about** |
172+
| **/v1/configuration** |
173+
| **/v1/devives** |
174+
| **/v1/register** |
175+
| **/v1/unregister** |
176+
| **/v1/qrcodelink** |
177+
| **/v1/accounts** |
178+
| **/v1/contacts** |
167179
168180
These Endpoints are blocked by default due to Security Risks, but can be modified by setting `BLOCKED_ENDPOINTS` to a valid json array string
169181

0 commit comments

Comments
 (0)