NoLog.cz/signal-gateway-dockerized
6
0
Fork 0
Code Issues 4 Pull requests Releases Wiki Activity

readme formatting

Browse source
This commit is contained in:
Matěj Divecký 2020-09-28 18:45:10 +02:00
parent 38b746711d
commit 464540de9a
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -5,30 +5,30 @@ It can be used as a gateway for automated notifications, bot with automatic repl
## Signald ## Signald
https://gitlab.com/thefinn93/signald https://gitlab.com/thefinn93/signald
daemon that facilitates communication over Signal. daemon that facilitates communication over Signal.
Using fixed pysignald https://gitlab.com/stavros/pysignald as python library. Latest version of pysignald is not compatible with changes in Signal protocol. Using fixed pysignald https://gitlab.com/stavros/pysignald as python library. Latest version of pysignald is not compatible with changes in Signal protocol.
Create directories `/signald, /signald/run, /signald/gradle` to avoid permissions issues with socket. You may still need to chown them if signald is not working Create directories `/signald, /signald/run, /signald/gradle` to avoid permissions issues with socket. You may still need to chown them if signald is not working
## registrations.json ## registrations.json
Simple json file that receiver and sender scripts use as source of registered Signal accounts. At this time registrations need to be added manually to this file. Simple json file that receiver and sender scripts use as source of registered Signal accounts.
At this time registrations need to be added manually to this file.
## Receiver ## Receiver
Creates threads for each registered number (in registrations.json) and listens for new messages. If there is new message, it writes it to RabbitMQ (queue signal-receive) for processing. Creates threads for each registered number (in registrations.json) and listens for new messages.
If there is new message, it writes it to RabbitMQ (queue signal-receive) for processing.
## Sender ## Sender
Listens for new messages in RabbitMQ (queue signal-send) and sends them to signald. Listens for new messages in RabbitMQ (queue signal-send) and sends them to signald.
## RabbitMQ ## RabbitMQ
Stores received messages and messages that are supposed to be sent out. Stores received messages and messages that are supposed to be sent out.
Reason for using it is to accomodate communication between scripts and to be able to receive, send and process messages asynchronously. Reason for using it is to accomodate communication between scripts and to be able to receive, send and process messages asynchronously.
## Worker ## Worker
Processes recieved messages in RabbitMQ and sends new messages into it. Processes recieved messages in RabbitMQ and sends new messages into it.
Doesn't care about the state of sending or receiving (for now). Doesn't care about the state of sending or receiving (for now).
More workers could be added for different tasks if needed. More workers could be added for different tasks if needed.
Right now, worker just takes received message and sends it back to the sender.
Right now, worker just takes received message and sends it back to the sender.
In future, there should be API for receiving messages from other apps and respond to automatic messages. In future, there should be API for receiving messages from other apps and respond to automatic messages.