For the complete documentation index, see llms.txt. This page is also available as Markdown.
Server Overview
Info on the BlueBubbles server app
Background
The server is primarily coded in TypeScript. Our first official stable release was published in August 2021 after extensive closed alpha and open beta testing since August 2020.
The server uses AppleScript to perform simple functions like sending messages & attachments and creating chats, and polls the chat.db database to see when new messages come in. We provide extra functionality in the form of the Private API bundle (docs linked in the sidebar), which uses native Objective-C to communicate with iMessage itself and access much deeper functions.
Supported Mac Devices
Any macOS device running Sierra and newer, with iMessage activated successfully.
Why macOS is required
BlueBubbles cannot run as an ordinary Linux or Windows container. The server relies on the macOS Messages app and its chat.db database, AppleScript, and, for optional Private API features, macOS-only frameworks, so it must run within macOS.
A Linux host can still use Docker or Podman as an advanced virtualization setup that runs a macOS virtual machine. See the macOS virtualization overview or the Docker-OSX guide for those setups. In both cases, BlueBubbles runs in the macOS guest rather than directly on the Linux host, and iMessage must be activated and working inside that guest.
macOS El Capitan is no longer supported
macOS VMs are also compatible, however you must be able to use iMessage (this involves some work with spoofing your hardware to seem like a real Mac inside the VMX file). See Running a macOS VM for more details.
If you'd like the most stable experience, we recommend going with Catalina or Big Sur.
