No project description provided
Project description
signal-cli-rest-api
signal-cli-rest-api is a wrapper around signal-cli and allows you to interact with it through http requests.
Features
- register/verify/unregister a number
- send messages to multiple users/a group with one or multiple attachments
- receive messages (with attachments)
- block/unblock users and groups
- link to existing device
- list/create/update/leave groups
- update profile (name/avatar)
To-Do
- integrate dbus daemon for faster sending
- authentication
Installation
pip
If you install signal-cli-rest-api through pip you need to manually install signal-cli on your system.
# by default the app will look for the signal config files in ~/.local/share/signal-cli
# you can change the directory by setting the SIGNAL_CONFIG_PATH env var to the desired path
# e.g. export SIGNAL_CONFIG_PATH=/opt/signal
pip install signal-cli-rest-api
uvicorn signal_cli_rest_api.main:app --host 0.0.0.0 --port 8000
Docker
export SIGNAL_DATA_DIR=~/signal/
docker run --name signal --restart unless-stopped -p 8000:8000 -v $SIGNAL_DATA_DIR:/root/.local/share/signal-cli sebastiannoelluebke/signal-cli-rest-api
docker-compose
git clone https://github.com/SebastianLuebke/signal-cli-rest-api.git
cd signal-cli-rest-api
# docker-compose build
docker-compose up -d
Security Notice
signal-cli-rest-api doesn't have any authentication for now. Everyone who knows the service address+port and the number is able to get your messages and send messages. So only use it a trusted environment and block external access.
Interactive Documentation
After installing signal-cli-rest-api start it and open the following page http://localhost:8000/docs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for signal-cli-rest-api-0.1.124.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbc6526df180d9fce8985a7cf2e9f9aa5e2ca121a90014f2c1cf9182fc8975a0 |
|
MD5 | 1b3c5476affb01c933ff4b750dec121d |
|
BLAKE2b-256 | 116af27bd5fe07edbb7e25345dfad1dd6c2947655aa34453196fb16ac16c4819 |
Close
Hashes for signal_cli_rest_api-0.1.124-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d5ab88b430947ba08a2a00dae18a73e7d87d6f62b6a3da43b1ab3cce3b05ba5 |
|
MD5 | 128aa81d48666547bd7dc6ac5cb22282 |
|
BLAKE2b-256 | 648fd9411abdf5de96e4be0ee2dcaada3ab825f399b169eaf9dc1b073ea51c35 |