Signal CLI REST API

Signal CLI REST API is a self-hosted Docker container that wraps signal-cli, the command-line client for the Signal messenger, in a Representational State…

  • Communication
  • Network Services
  • Productivity
  • Security
  • Tools & Utilities
Signal CLI REST API is a self-hosted Docker container that wraps signal-cli, the command-line client for the Signal messenger, in a Representational State Transfer (REST) API. It exposes core Signal features such as registering and verifying a number, sending and receiving messages with attachments, linking devices, and creating, listing, and removing groups, so you can script and automate Signal from your own services, chatbots, or home automation. It is well suited to homelabbers who want a programmatic way to integrate Signal messaging into their own backends.

Platform availability

Available on 3 of 10 platforms

  • Unraid
  • TrueNAS
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

80/100 Excellent

Maintained
100last commit 10 days ago
Popular
692,920 GitHub stars
Easy to install
553 install platforms, install notes, Docker image
Light to run
No data

Based on 3 of 4 factors.

Availability: platform listings confirmed today, links checked today

GitHub stars
2,920
Open issues
166
Last commit
2026-11-10
Latest release
0.101
License
MIT
Activity
declining

Checked 5 days ago - source: GitHub (bbernhard/signal-cli-rest-api)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Choose USB or networked receiver Before starting, decide whether the receiver is connected by USB or over the network, and if using the networked option make sure the app can reach the receiver's default network address/port. If that connection is blocked or wrong, the app cannot open the device and no data will appear. source
  • Set a safe expected signal level Set a conservative reference level before capturing, which tells the receiver the strongest signal it should expect. If it is too low for a strong signal, the input can overload and distort the measurement. source
  • Set the frequency range you need Set the center frequency (the middle of the range) and bandwidth (the width of the range) to cover the signal you want to measure. If they do not cover it, the app may record the wrong slice of spectrum or miss the signal. source
  • Persist configuration Create a configuration directory (for example ~/.local/share/signal-api) before the first run so your signal-cli registration is saved. This lets you update by deleting and recreating the container without having to re-register your number. source
  • Create a configuration directory before starting Create a directory for the configuration (e.g. mkdir -p ~/.local/share/signal-api). Persisting config there lets you update signal-cli-rest-api by deleting and recreating the container without re-registering your Signal number. source

Fetched today - each note links to its source

Alternatives (12)

  • Briar - Censorship-resistant peer-to-peer messaging that bypasses centralized servers.
  • Conduit - Conduit is a lightweight, self-contained Matrix server written in Rust for running your own chat backend with minimal setup and low system…
  • Discord
  • Element
  • Jami - Jami is a free/libre, end-to-end encrypted communication app for private messaging, voice calls, and video conferences.
  • Jitsi Meet - Jitsi Meet is an open-source, self-hosted video conferencing platform offering HD audio and video, screen sharing, in-meeting chat, and unl…
  • Matrix - Matrix is a free, open-source protocol and server for secure, decentralized real-time messaging.
  • RetroShare - RetroShare is a free, open-source, decentralized communication toolkit that establishes encrypted peer-to-peer connections between your dev…
  • SimpleX Chat - SimpleX Chat is a private messaging app that protects your identity by not using phone numbers or usernames.
  • Telegram - Telegram is a cloud-based mobile and desktop messaging app.
  • Tencent QQ - QQ is a widely used Chinese instant messaging service developed by Tencent, offering chat, voice, and video communication.
  • Threema - Threema is a new mobile messaging app that puts security first.

Checked 40 days ago - source: AlternativeTo

Common questions

How do I choose the API execution mode?

Set the MODE environment variable to select the execution mode. Normal mode is the default and invokes signal-cli for every REST API request.

What should I check if the Docker container exits with code 0?

Make sure the host port is not already occupied by another process.

Can this be used with Uptime Kuma Signal notifications?

Yes, a self-hoster installed signal-cli-rest-api after seeing it mentioned in Uptime Kuma's Signal notification setup.

Does the API support device linking, groups, and attachments?

Yes, it can link devices, create and manage groups, and handle attachments, in addition to registering a number and sending or receiving messages.

Answers sourced from github.com, github.com, selfhost.directory, www.reddit.com

Community

Collected 49 days ago - public community threads