Skip to main content

Broadcast bot for Signal

Project description

signalblast

Signalblast is a tool to send encrypted messages anonymously over Signal to a subscriber list. The sender does not know who the subscribers in the list are, nor the subscribers know who the sender is.

A server is required to host the bot, find instructions on how the set it up below.

The idea for this bot came from Signalboost, which unfortunately is no longer alive.

Usage

Once the bot is up and running, several commands are available:

  • !subscribe send this to sign up to the list
  • !broadcast after subscribing any message preceded by this will be broadcasted to every subscriber
  • !unsubscribe to stop receiving messages
  • !help to be reminded of which commands are available
  • !admin send a message only to the list admin, useful for getting technical support

Installation

Option 1: local python environment

  • Set up signalbot as specified here
  • Create a new virtual environment, uv is recommended
  • Install with pip install signalblast
  • Run via python -m signalblast.main

Option 2: docker compose

This will pull the project docker images from https://hub.docker.com/r/eradorta/signalblast

  • Install docker.
  • Download the docker-compose.yml file.
  • Create a folder called signalblast_data
  • Define the relevant environment variables
    export DOCKER_TAG="The version of signalblast to run, can be latest"
    export SIGNALBLAST_PHONE_NUMBER="The phone number of the bot"
    export SIGNALBLAST_PASSWORD="The password for the admin"
    export SIGNALBLAST_HEALTHCHECK_RECEIVER="The contact or group to send health check messages"
    
  • Run via docker compose: docker compose up

Development

  • Set up docker and signalbot as specified in the installation section.
  • Clone the repo
  • Install uv
  • Install the repo and the dependencies in a new virtual environment with uv sync
  • Install the pre-commit hook uv run pre-commit install
  • Run
    • Directly via uv run python -m signalblast.main
    • Via systemd with systemd/signalblast.service
      • Run once with the password in the env file.
      • From there one, the password is stored encrypted and it can be removed from the env file
  • Optional: install signalbot as an editable dependency uv add --editable ../signalbot/

Docker compose

The docker/compose_build.sh and docker/compose_up.sh are provide for easier development.

Roadmap

  • Make instructions clearer and add pictures to the readme
  • Add unit testing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

signalblast-0.8.1.tar.gz (121.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

signalblast-0.8.1-py3-none-any.whl (34.6 kB view details)

Uploaded Python 3

File details

Details for the file signalblast-0.8.1.tar.gz.

File metadata

  • Download URL: signalblast-0.8.1.tar.gz
  • Upload date:
  • Size: 121.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for signalblast-0.8.1.tar.gz
Algorithm Hash digest
SHA256 81b8d982af039dbcfa00dffa56cdbd551d8b84780a124411202507e7f6049ada
MD5 2d636d84d843ab010cd2de0503211b28
BLAKE2b-256 5f8bc6b2f90e1c1bbfd612200351787a806693bf2677b74c139f4d15fca88211

See more details on using hashes here.

Provenance

The following attestation bundles were made for signalblast-0.8.1.tar.gz:

Publisher: publish-pypi.yml on Era-Dorta/signalblast

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file signalblast-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: signalblast-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 34.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for signalblast-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a06cd219f4d8a64a7645d0435883e190124311e8089bb2ebdb3947c9dedb45af
MD5 e39ae01d7754b065e183f72dade7dd12
BLAKE2b-256 8b4708b84db6891d84c6f7419bd6567a07beac9422a0d2e4fd1f464f32e423dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for signalblast-0.8.1-py3-none-any.whl:

Publisher: publish-pypi.yml on Era-Dorta/signalblast

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page