Skip to content

Commit 4c84f9b

Browse files
committed
copy config
1 parent ac4614f commit 4c84f9b

File tree

4 files changed

+13
-10
lines changed

4 files changed

+13
-10
lines changed

.dockerignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
.git
33
.github
44
*.yaml
5-
LICENSE
65
*.md
6+
!LICENSE.md
7+
!README.md
78
!config/*.yml

.github/templates/README.template.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Get the latest version of the `docker-compose.yaml` file:
88

9-
And add secure Token(s) to `API_TOKEN` / `API_TOKENS`. See [API_TOKEN(s)](#api-tokens)
9+
And add secure Token(s) to `API__TOKEN` / `API__TOKENS`. See [API\_\_TOKEN(s)](#api-tokens)
1010

1111
> [!IMPORTANT]
1212
> This Documentation will be using `sec-signal-api:8880` as the service host,
@@ -47,20 +47,20 @@ Secured Signal API provides 3 Ways to Authenticate
4747

4848
### Bearer
4949

50-
To Authenticate add `Authorization: Bearer API_TOKEN` to your request Headers
50+
To Authenticate add `Authorization: Bearer API__TOKEN` to your request Headers
5151

5252
### Basic Auth
5353

5454
To use Basic Auth as Authorization Method add `Authorization: Basic BASE64_STRING` to your Headers
5555

5656
User is `api` (LOWERCASE)
5757

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

6060
example:
6161

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

6666
=> `YXBpOkFQSV9LRVkK`
@@ -73,7 +73,7 @@ in this case you can use **Query Auth**.
7373
Here is a simple example:
7474

7575
```bash
76-
curl -X POST http://sec-signal-api:8880/v2/send?@authorization=API_TOKEN
76+
curl -X POST http://sec-signal-api:8880/v2/send?@authorization=API__TOKEN
7777
```
7878

7979
Notice the `@` infront of `authorization`. See [Formatting](#format).
@@ -83,7 +83,7 @@ Notice the `@` infront of `authorization`. See [Formatting](#format).
8383
To send a message to 1234567:
8484

8585
```bash
86-
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer API_TOKEN" -d '{"message": "Hello World!", "recipients": ["1234567"]}' http://sec-signal-api:8880/v2/send
86+
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer API__TOKEN" -d '{"message": "Hello World!", "recipients": ["1234567"]}' http://sec-signal-api:8880/v2/send
8787
```
8888

8989
### Advanced
@@ -142,13 +142,13 @@ you have to add `@` in front of any KeyValue Pair assignment.
142142

143143
### API Token(s)
144144

145-
Both `API_TOKEN` and `API_TOKENS` support multiple Tokens seperated by a `,` **Comma**.
145+
Both `API__TOKEN` and `API__TOKENS` support multiple Tokens seperated by a `,` **Comma**.
146146
During Authentication Secured Signal API will try to match the given Token against the list of Tokens inside of these Variables.
147147

148148
```yaml
149149
environment:
150-
API_TOKEN: "token1, token2, token3"
151-
API_TOKENS: "token1, token2, token3"
150+
API__TOKEN: "token1, token2, token3"
151+
API__TOKENS: "token1, token2, token3"
152152
```
153153
154154
> [!IMPORTANT]

Dockerfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ ARG TARGETARCH
1313

1414
WORKDIR /app
1515

16+
COPY /app/config ./config
17+
1618
COPY dist/${TARGETOS}/${TARGETARCH}/app .
1719

1820
RUN ls
File renamed without changes.

0 commit comments

Comments
 (0)