mirror of
https://github.com/aljazceru/signal-cli-rest-api.git
synced 2026-01-13 03:44:35 +01:00
b0b3dc761b
This uses mulit-stage build to separate the build phase from the distribution image and signigicantly reduces images size. You can find more information on Docker multistage builds here: https://docs.docker.com/develop/develop-images/multistage-build/
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.
network_mode: "host"
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