Skip to content

Commit

Permalink
Polish the signal section of the documentation.
Browse files Browse the repository at this point in the history
Signed-off-by: Claus-Justus Heine <[email protected]>
  • Loading branch information
rotdrop committed Jun 19, 2023
1 parent 9a4c362 commit 55aadd0
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions doc/Admin Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,16 @@ occ twofactorauth:gateway:configure sms
URL: https://www.signal.org/
Stability: Experimental

This gateways allows you to send messages via the Signal protocol. The Signal gateway can be
run as a Docker container. The image for the gateway including setup instructions can be found on
[GitLab](https://gitlab.com/morph027/signal-web-gateway).
This gateways allows you to send messages via the Signal protocol. By
default it tries to use the native HTTP endpoint of
[signal-cli](https://github.com/AsamK/signal-cli) which is available
since [signal-cli 0.11.5](https://github.com/AsamK/signal-cli/blob/master/CHANGELOG.md#0115---2022-11-07).

If the native HTTP endpoint of signal-cli is not available then it
tries to use the REST service provided by either
[stand-alone Python signal-cli REST API](https://morph027.gitlab.io/python-signal-cli-rest-api)
or
[Docker signal-cli REST API](https://github.com/bbernhard/signal-cli-rest-api)

*Note: Signal users are bound to phone numbers. If you already use Signal on your phone, you
need a separate number for the gateway's registration.*
Expand All @@ -43,6 +50,9 @@ Once you've set up the gateway, you can configure this app interactively:
occ twofactorauth:gateway:configure signal
```

You need to speficy the URL where the API provider is listening and
the Signal-account of the sending Signal user.

### Telegram
URL: https://www.telegram.org/
Stability: Unstable
Expand Down

0 comments on commit 55aadd0

Please sign in to comment.