webmaster/signal-cli-http
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions
signal-cli-http/readme.md
50501AZ Webmaster 05772e562c Oops
2025-08-01 15:29:30 -07:00

1.1 KiB
Raw Permalink Blame History

Signal-CLI HTTP

Very simple HTTP frontend to signal-cli JSON RPC.

Please see the JSONRPC documentation for signal-cli: https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-jsonrpc.5.adoc

Please also read the following README files for the individual modules to understand how to configure and interact with this program:

  • args handles command line arguments. Go here to learn how to run the program.
  • auth handles the authentication JSON and checking requests. Go here to learn how to secure the program, and whitelist authentication keys.
  • subprocess manages the underlying signal-cli JSONRPC process, along with caching incoming messages. Go here to understand how this program relays and returns the JSON objects.
  • web - handles the HTTP requests to this program, including the necessary edge cases. Go here to understand how to send and understand the responses to the program's HTTP endpoint.