Skip to content

Commit 74408ff

Browse files
committed
add integrations section
1 parent bdccfbb commit 74408ff

File tree

7 files changed

+44
-5
lines changed

7 files changed

+44
-5
lines changed

docs/best-practices/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 5
33
title: Best Practices
44
---
55

docs/features/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 7
2+
sidebar_position: 2
33
title: Features
44
---
55

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Getting Started",
3-
"position": 2
3+
"position": 3
44
}

docs/integrations/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Integrations",
3+
"position": 8
4+
}

docs/integrations/compatibility.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
sidebar_position: 1
3+
title: Compatibility
4+
---
5+
6+
# Compatibility
7+
8+
## The Problem
9+
10+
**Secured Signal API** is only of use when compatible with programms.
11+
Even if it keeps the underlying Signal CLI REST API you'd still need your services to support Signal CLI REST API.
12+
13+
## The Solution
14+
15+
**Secured Signal API** implements enough features to technically support any and all services.
16+
But with one flaw:
17+
18+
> _manual configuration_
19+
20+
In order for Secured Signal API to be compatible and integratable with a service you still need to manually define [**Data Aliases**](../configuration/data-aliases)
21+
and [**Message Templates**](../configuration/message-templates), which is quite easy,
22+
provided you know what the services is using as payload (try sending a request to some debugging endpoint).
23+
24+
> _Now wouldn't it be great if someone had already done that?_
25+
26+
If you are using a common and popular service or programm there is probably someone who already configured everything and was willing to share it on
27+
[our Github Discussions](https://github.com/codeshelldev/secured-signal-api/discussions) (**Thank you!**).
28+
29+
## How to Help
30+
31+
You successfully integrated a service and want to share it?
32+
33+
> Well that's nice of you 🤩👍️
34+
35+
Then create a [Discussion](https://github.com/CodeShellDev/secured-signal-api/discussions/categories/integrations) and share your configs or if you want you can also submit a [Pull Request](https://github.com/codeshelldev/secured-signal-api/pulls) to add your integration to the [**Integrations Section**](.) in the official Documentation.

docs/reverse-proxy/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Reverse Proxy",
3-
"position": 6
3+
"position": 7
44
}

docs/usage/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Usage",
3-
"position": 3
3+
"position": 4
44
}

0 commit comments

Comments
 (0)