slidge-whatsapp

A feature-rich WhatsApp to XMPP puppeteering gateway, based on slidge and whatsmeow.

PyPI package version CI pipeline status Chat

Installation

Refer to the slidge admin documentation for general info on how to set up an XMPP server component.

Containers

From the codeberg package registry

# use docker.io/ravermeister/slidge-whatsapp for arm64 (thanks raver! <3)
docker run codeberg.org/slidge/slidge-whatsapp  # works with podman too

Python package

With pipx:

# for the latest stable release (if any)
pipx install slidge-whatsapp

# for the bleeding edge
pipx install slidge-whatsapp==0.0.0.dev0 \
    --pip-args='--extra-index-url https://codeberg.org/api/packages/slidge/pypi/simple/'

# to update bleeding edge installs
pipx install slidge-whatsapp==0.0.0.dev0 \
    --pip-args='--extra-index-url https://codeberg.org/api/packages/slidge/pypi/simple/' --force

slidge-whatsapp --help

Make sure to install ffmpeg for full outgoing media compatibility; for example, in Debian/Ubuntu:

sudo apt install ffmpeg

Documentation

Hosted on codeberg pages.

Dev

git clone https://codeberg.org/slidge/slidge-whatsapp
cd slidge-whatsapp
docker-compose up  # works with podman-compose too