Skip to content

docs: quote blocked endpoints #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 1, 2025
Merged

docs: quote blocked endpoints #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions .github/templates/README.template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,15 +236,18 @@ You can modify endpoints by configuring `access.endpoints` in your config:
settings:
access:
endpoints:
- !/v1/register
- !/v1/unregister
- !/v1/qrcodelink
- !/v1/contacts
- "!/v1/register"
- "!/v1/unregister"
- "!/v1/qrcodelink"
- "!/v1/contacts"
- /v2/send
```

By default adding an endpoint explictly allows access to it, use `!` to block it instead.

> [!IMPORTANT]
> When using `!` to block you must enclose the endpoint with quotes, like in the example above.

| Config (Allow) | (Block) | Result | | | |
| :------------- | :------------- | :--------: | --- | :---------------: | --- |
| `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |
Expand Down
11 changes: 7 additions & 4 deletions docs/configuration/endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,18 @@ You can modify endpoints by configuring `access.endpoints` in your config:
settings:
access:
endpoints:
- !/v1/register
- !/v1/unregister
- !/v1/qrcodelink
- !/v1/contacts
- "!/v1/register"
- "!/v1/unregister"
- "!/v1/qrcodelink"
- "!/v1/contacts"
- /v2/send
```

By default adding an endpoint explictly allows access to it, use `!` to block it instead.

> [!IMPORTANT]
> When using `!` to block you must enclose the endpoint in quotes, like in the example above

| Config (Allow) | (Block) | Result | | | |
| :------------- | :------------- | :--------: | --- | :---------------: | --- |
| `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |
Expand Down