Debian Codegraph @

pkg/services/chat/signal/doc.go

raw
1 // Package signal provides functionality to send notifications via Signal Messenger
2 // through REST API servers that wrap the signal-cli command-line interface.
3 //
4 // This service supports sending text messages and base64-encoded attachments to
5 // individual phone numbers and Signal groups. Authentication supports both HTTP
6 // Basic Auth and Bearer tokens for compatibility with different API servers.
7 //
8 // It requires a Signal API server (such as signal-cli-rest-api or secured-signal-api)
9 // to be running and configured with a registered Signal account.
10 //
11 // URL format: signal://[user:pass@]host:port/source_phone/recipient1/recipient2
12 // URL format: signal://host:port/source_phone/recipient1/recipient2?token=apikey
13 //
14 // For setup instructions and API server options, see the service documentation.
15 package signal