> For the complete documentation index, see [llms.txt](https://docs.bluebubbles.app/landing-page/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bluebubbles.app/landing-page/readme.md).

# BlueBubbles Documentation

Learn how to setup and use BlueBubbles!

![BlueBubbles On Phone and Desktop](https://3195171765-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlwlR6EBMG830tm8gKGvp%2Fuploads%2FE4EevD4vufe2YGtQzobH%2Fimage.png?alt=media\&token=467d022b-a4dc-4183-8f28-3d66edb15562)

Hey there! Welcome to the BlueBubbles documentation! Check out the server, client, and Private API guides using the sidebar. If you are on mobile, you may need to open it using the hamburger menu.

Below are some quick links to documentation you may find useful

### Quick Links

{% embed url="<https://bluebubbles.app/install/>" %}
Install Guide on Our Main Website
{% endembed %}

{% embed url="<https://bluebubbles.app/faq>" %}
Frequently Asked Questions
{% endembed %}

{% embed url="<https://docs.bluebubbles.app/helper-bundle/installation>" %}
Get Enhanced Features using the Private API
{% endembed %}

{% embed url="<https://docs.bluebubbles.app/server/developer-guides/rest-api-and-webhooks>" %}
Use BlueBubbles Programmatically
{% endembed %}

{% embed url="<https://docs.bluebubbles.app/server/advanced/running-on-macos-vm>" %}
How to Setup a Virtual MacOS Device
{% endembed %}

{% embed url="<https://docs.bluebubbles.app/server/advanced/multiple-users-on-the-same-mac>" %}

{% embed url="<https://docs.bluebubbles.app/server/advanced/registering-a-phone-number-with-your-imessage-account>" %}

{% embed url="<https://docs.bluebubbles.app/server/advanced/generating-an-ssl-certificate-using-certbot>" %}

{% embed url="<https://docs.bluebubbles.app/server/troubleshooting-guides/not-receiving-notifications-or-url-changes-on-android>" %}
Troubleshooting Notifications & Disconnects
{% endembed %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.bluebubbles.app/landing-page/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.