Skip to content

Commit 8b276c6

Browse files
Automated README update (#119)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent e478ccd commit 8b276c6

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,14 @@ settings:
225225
226226
access:
227227
endpoints:
228-
- !/v1/about
228+
- "!/v1/about"
229229
- /v2/send
230+
231+
fieldPolicies:
232+
"@number": {
233+
value: "+123400003",
234+
action: block
235+
}
230236
```
231237

232238
#### Token Configs
@@ -247,7 +253,7 @@ overrides:
247253
248254
access:
249255
endpoints: # Disable Sending
250-
- !/v2/send
256+
- "!/v2/send"
251257
```
252258

253259
### Templating
@@ -314,15 +320,15 @@ Since Secured Signal API is just a Proxy you can use all of the [Signal REST API
314320

315321
| Endpoint | |
316322
| :-------------------- | ------------------ |
317-
| **/v1/about** | **/v1/unregister** |
318-
| **/v1/configuration** | **/v1/qrcodelink** |
323+
| **/v1/configuration** | **/v1/unregister** |
319324
| **/v1/devices** | **/v1/contacts** |
320325
| **/v1/register** | **/v1/accounts** |
326+
| **/v1/qrcodelink** | |
321327

322328
These Endpoints are blocked by default due to Security Risks.
323329

324330
> [!NOTE]
325-
> Matching works by checking if the requested Endpoints starts with a Blocked or an Allowed Endpoint
331+
> Matching uses [glob-style patterns](https://www.gnu.org/software/bash/manual/html_node/Pattern-Matching.html): `*` matches any sequence of characters, `?` matches a single character and `[abc]` matches one of the characters in the brackets
326332

327333
You can modify endpoints by configuring `access.endpoints` in your config:
328334

@@ -346,7 +352,7 @@ By default adding an endpoint explictly allows access to it, use `!` to block it
346352
| :------------- | :------------- | :--------: | --- | :---------------: | --- |
347353
| `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |
348354
| `unset` | `!/v1/receive` | **all** | ✅ | **`/v1/receive`** | 🛑 |
349-
| `/v2` | `!/v2/send` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |
355+
| `!/v2*` | `/v2/send` | **`/v2*`** | 🛑 | **`/v2/send`** | ✅ |
350356

351357
### Variables
352358

0 commit comments

Comments
 (0)