@@ -67,39 +67,7 @@ endpoint restrictions, placeholders, flexible configuration
6767Get the latest version of the ` docker-compose.yaml ` file:
6868
6969``` yaml
70- services :
71- signal-api :
72- image : bbernhard/signal-cli-rest-api:latest
73- container_name : signal-api
74- environment :
75- - MODE=normal
76- volumes :
77- - ./data:/home/.local/share/signal-cli
78- restart : unless-stopped
79- networks :
80- backend :
81- aliases :
82- - signal-api
83-
84- secured-signal :
85- image : ghcr.io/codeshelldev/secured-signal-api:latest
86- container_name : secured-signal
87- environment :
88- API__URL : http://signal-api:8080
89- SETTINGS__VARIABLES__RECIPIENTS :
90- ' [+123400002, +123400003, +123400004]'
91- SETTINGS__VARIABLES__NUMBER : " +123400001"
92- API__TOKENS : ' [LOOOOOONG_STRING]'
93- ports :
94- - " 8880:8880"
95- restart : unless-stopped
96- networks :
97- backend :
98- aliases :
99- - secured-signal-api
100-
101- networks :
102- backend :
70+ file not found : /home/runner/work/secured-signal-api/secured-signal-api/docs-src/getting-started/examples/docker-compose.yaml
10371` ` `
10472
10573And add secure Token(s) to ` api.tokens`. See [API TOKENs](#api-tokens).
@@ -196,34 +164,7 @@ To change the internal config file location set `CONFIG_PATH` in your **Environm
196164This example config shows all of the individual settings that can be applied :
197165
198166` ` ` yaml
199- # Example Config (all configurations shown)
200- service:
201- port: 8880
202-
203- api:
204- url: http://signal-api:8080
205- tokens: [token1, token2]
206-
207- logLevel: info
208-
209- settings:
210- messageTemplate: |
211- You've got a Notification:
212- {{@message}}
213- At {{@data.timestamp}} on {{@data.date}}.
214- Send using {{.NUMBER}}.
215-
216- variables:
217- number: "+123400001"
218- recipients: ["+123400002", "group.id", "user.id"]
219-
220- dataAliases:
221- "@message": [{ alias: "msg", score: 100 }]
222-
223- blockedEndpoints:
224- - /v1/about
225- allowedEndpoints:
226- - /v2/send
167+ file not found: /home/runner/work/secured-signal-api/secured-signal-api/docs-src/configuration/examples/config.yml
227168` ` `
228169
229170# ### Token Configs
@@ -235,13 +176,7 @@ This way you can permission tokens by further restricting or adding [Endpoints](
235176Here is an example :
236177
237178` ` ` yaml
238- tokens: [LOOOONG_STRING]
239-
240- overrides:
241- variables: # Disable Placeholder
242- blockedEndpoints: # Disable Sending
243- - /v2/send
244- dataAliases: # Disable Aliases
179+ file not found: /home/runner/work/secured-signal-api/secured-signal-api/docs-src/configuration/examples/token.yml
245180` ` `
246181
247182# ## Templating
@@ -257,32 +192,7 @@ Go's templating library is used in the following features:
257192This makes advanced [Message Templates](#message-templates) like this one possible:
258193
259194` ` ` yaml
260- settings:
261- messageTemplate: |
262- {{- $greeting := "Hello" -}}
263- {{ $greeting }}, {{ @name }}!
264- {{ if @age -}}
265- You are {{ @age }} years old.
266- {{- else -}}
267- Age unknown.
268- {{- end }}
269- Your friends:
270- {{- range @friends }}
271- - {{ . }}
272- {{- else }}
273- You have no friends.
274- {{- end }}
275- Profile details:
276- {{- range $key, $value := @profile }}
277- - {{ $key }}: {{ $value }}
278- {{- end }}
279- {{ define "footer" -}}
280- This is the footer for {{ @name }}.
281- {{- end }}
282- {{ template "footer" . -}}
283- ------------------------------------
284- Content-Type: {{ #Content_Type }}
285- Redacted Auth Header: {{ #Authorization }}
195+ file not found: /home/runner/work/secured-signal-api/secured-signal-api/docs-src/configuration/examples/message-template.yml
286196` ` `
287197
288198# ## API Tokens
0 commit comments