mirror of
https://github.com/bbernhard/signal-cli-rest-api.git
synced 2026-02-02 20:13:33 +00:00
136fa62698
This reverts commit 9b4ee24a0e3bc675b6e974cd456a378fe562c19f. Unfortunately, this change breaks backwards compatibility. (Due to permission issues, existing bind mounts wouldn't work anymore and users would need to manually adapt permissions in order to get it working again). Will revert this change for now, until a backwards compatible solution is found
Dockerized Signal Messenger REST API
This project creates a small dockerized REST API around signal-cli.
At the moment, the following functionality is exposed via REST:
- Register a number
- Verify the number using the code received via SMS
- Send message (+ attachments) to multiple recipients (or a group)
- Receive messages
- Link devices
- Create/Liste/Remove groups
Examples
Sample docker-compose.ymlfile:
version: "3"
services:
signal-cli-rest-api:
image: bbernhard/signal-cli-rest-api:latest
ports:
- "8080:8080" #map docker port 8080 to host port 8080.
volumes:
- "./signal-cli-config:/home/.local/share/signal-cli" #map "signal-cli-config" folder on host system into docker container. the folder contains the password and cryptographic keys when a new number is registered
The Swagger API documentation can be found here. If you prefer a simple text file like API documentation have a look here
In case you need more functionality, please file a ticket or create a PR