Skip to content

Update Main #22

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 2 commits into from
Aug 24, 2025
Merged

Update Main #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aae7fbb
fixed Headers in README
CodeShellDev Aug 24, 2025
fe9a1ff
Update README.md
github-actions[bot] Aug 24, 2025
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
12 changes: 6 additions & 6 deletions .github/templates/README.template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,9 @@ Supported types include **strings**, **ints** and **arrays**
In order to differentiate Injection Queries and _regular_ Queries
you have to add `@` in front of any KeyValue Pair assignment.

### Environment Variables
## Environment Variables

#### API Token(s)
### API Token(s)

Both `API_TOKEN` and `API_TOKENS` support multiple Tokens seperated by a `,` **Comma**.
During Authentication Secured Signal API will try to match the given Token against the list of Tokens inside of these Variables.
Expand All @@ -162,7 +162,7 @@ like Blocked Endpoints and any sort of Auth.
> [!NOTE]
> Blocked Endpoints can be reactivated by manually setting them in the Environment

#### Blocked Endpoints
### Blocked Endpoints

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...

Expand Down Expand Up @@ -191,7 +191,7 @@ By default Secured Signal API provides the following Placeholders:
- **NUMBER** = _ENV_: `NUMBER`
- **RECIPIENTS** = _ENV_: `RECIPIENTS`

#### Customization
### Customization

Placeholders can be added by setting `VARIABLES` inside your Environment.

Expand All @@ -200,7 +200,7 @@ environment:
VARIABLES: ' "NUMBER2": "002", "GROUP_CHAT_1": [ "user.id", "000", "001", "group.id" ] '
```

#### Recipients
### Recipients

Set this Environment Variable to automatically provide default Recipients:

Expand All @@ -217,7 +217,7 @@ example:
}
```

#### Message Aliases
### Message Aliases

To improve compatibility with other services Secured Signal API provides aliases for the `message` attribute by default:

Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,9 +197,9 @@ Supported types include **strings**, **ints** and **arrays**
In order to differentiate Injection Queries and _regular_ Queries
you have to add `@` in front of any KeyValue Pair assignment.

### Environment Variables
## Environment Variables

#### API Token(s)
### API Token(s)

Both `API_TOKEN` and `API_TOKENS` support multiple Tokens seperated by a `,` **Comma**.
During Authentication Secured Signal API will try to match the given Token against the list of Tokens inside of these Variables.
Expand All @@ -221,7 +221,7 @@ like Blocked Endpoints and any sort of Auth.
> [!NOTE]
> Blocked Endpoints can be reactivated by manually setting them in the Environment

#### Blocked Endpoints
### Blocked Endpoints

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...

Expand Down Expand Up @@ -250,7 +250,7 @@ By default Secured Signal API provides the following Placeholders:
- **NUMBER** = _ENV_: `NUMBER`
- **RECIPIENTS** = _ENV_: `RECIPIENTS`

#### Customization
### Customization

Placeholders can be added by setting `VARIABLES` inside your Environment.

Expand All @@ -259,7 +259,7 @@ environment:
VARIABLES: ' "NUMBER2": "002", "GROUP_CHAT_1": [ "user.id", "000", "001", "group.id" ] '
```

#### Recipients
### Recipients

Set this Environment Variable to automatically provide default Recipients:

Expand All @@ -276,7 +276,7 @@ example:
}
```

#### Message Aliases
### Message Aliases

To improve compatibility with other services Secured Signal API provides aliases for the `message` attribute by default:

Expand Down