# BlueBubbles Server

## BlueBubbles Server

- [Server Overview](https://docs.bluebubbles.app/server/readme.md): Info on the BlueBubbles server app
- [Installation Guides](https://docs.bluebubbles.app/server/installation-guides.md)
- [Manual Setup](https://docs.bluebubbles.app/server/installation-guides/manual-setup.md): Set up BlueBubbles without signing into your Google account
- [Supporting the Project](https://docs.bluebubbles.app/server/supporting-the-project.md): How can you support the project?
- [Licenses / Legal](https://docs.bluebubbles.app/server/licenses-legal.md)
- [Basic Guides - Overview](https://docs.bluebubbles.app/server/basic-guides/basic-guides-overview.md): Here you'll find simple guides for using BlueBubbles
- [Port Forwarding & Dynamic DNS](https://docs.bluebubbles.app/server/basic-guides/port-forwarding-and-dynamic-dns.md): This guide will show you how to port-forward using your home's router, so you can connect directly to your BlueBubbles server using a Dynamic DNS. No need for a third-party proxy service.
- [Prevent macOS from Sleeping](https://docs.bluebubbles.app/server/basic-guides/preventing-macos-from-sleeping.md): This page will show you multiple options for preventing your mac from sleeping. While there are multiple ways, we do have a recommended way... see below.
- [Migrating Servers](https://docs.bluebubbles.app/server/basic-guides/migrating-servers.md): If you want to change the Mac server that your BlueBubbles Server runs on, you've come to the right place!
- [Multiple Users on the Same Mac](https://docs.bluebubbles.app/server/basic-guides/multiple-users-on-the-same-mac.md): This guide helps you run BlueBubbles for multiple people on the same Mac
- [Autostart Server After Crash](https://docs.bluebubbles.app/server/basic-guides/autostart-server-after-crash.md): This document will guide you on how you can configure your Mac to automatically restart the BlueBubbles Server app if the app crashes (unsafe exit)
- [Troubleshooting Guides - Overview](https://docs.bluebubbles.app/server/troubleshooting-guides/troubleshooting-guides-overview.md): The following guides are to help you if you run into any issues setting up or using the BlueBubbles Server.
- [BlueBubbles Server Cannot Access MacOS Contacts](https://docs.bluebubbles.app/server/troubleshooting-guides/bluebubbles-server-cannot-access-macos-contacts.md): The following guide will show you how you can manually modify the TCC database to allow BlueBubbles to access your macOS Contacts.
- [Not Receiving Notifications or URL Changes on Android](https://docs.bluebubbles.app/server/troubleshooting-guides/not-receiving-notifications-or-url-changes-on-android.md): This page will help you troubleshoot and (hopefully) fix issues with not receiving notifications or URL changes on the Android app
- [Unable to Send Messages to International Contacts](https://docs.bluebubbles.app/server/troubleshooting-guides/unable-to-send-messages-to-international-contacts.md): This document will guide you on how to fix issues with sending messages to international phone numbers.
- [BlueBubbles App is Taking Up Too Much Storage](https://docs.bluebubbles.app/server/troubleshooting-guides/bluebubbles-app-is-taking-up-too-much-storage.md): This guide will show you how you can free up storage that the BlueBubbles App is taking up
- [Can't Send Messages from BlueBubbles](https://docs.bluebubbles.app/server/troubleshooting-guides/cant-send-messages-from-bluebubbles.md): This guide will show you how you can troubleshoot issues with sending messages through BlueBubbles.
- [BlueBubbles Server Opens to a Blank White Screen](https://docs.bluebubbles.app/server/troubleshooting-guides/bluebubbles-server-opens-to-a-blank-white-screen.md): This document will show you how you can fix the blank white screen issue when opening the BlueBubbles Server
- [Slow Upload Speed When Connecting Over LAN](https://docs.bluebubbles.app/server/troubleshooting-guides/slow-upload-speed-when-connecting-over-lan.md): This document will help you fix slow upload speeds when connecting to your BlueBubbles Server over your LAN.
- [Restarting Your Server Without a Direct Connection](https://docs.bluebubbles.app/server/troubleshooting-guides/restarting-your-server-without-a-direct-connection.md): This page will show you how you can restart your server, even when your app isn't connected
- [Fix FaceTime Features for Virtual Machines](https://docs.bluebubbles.app/server/troubleshooting-guides/fix-facetime-features-for-virtual-machines.md): This document will guide you on possibly fixing the FaceTime features when using a macOS virtual machine.
- [Advanced Guides - Overview](https://docs.bluebubbles.app/server/advanced/advanced-guides-overview.md): Here you will find more advanced guides for using BlueBubbles
- [Generating an SSL Certificate using CertBot](https://docs.bluebubbles.app/server/advanced/generating-an-ssl-certificate-using-certbot.md): Learn how you can generate an SSL Certificate using CertBot for BlueBubbles. This is especially useful for dynamic DNS setups.
- [Disabling SIP on Unofficial Macs for the Private API](https://docs.bluebubbles.app/server/advanced/disabling-sip-on-unofficial-macs-for-the-private-api.md)
- [Registering a Phone Number with your iMessage Account](https://docs.bluebubbles.app/server/advanced/registering-a-phone-number-with-your-imessage-account.md): This page will guide you on how you can link your phone number with your iMessage account. By default, BlueBubbles will use your iCloud email to send iMessages.
- [macOS Virtualization](https://docs.bluebubbles.app/server/advanced/macos-virtualization.md): Here, you will find guides on virtualizing macOS, whether that be in a virtual machine, or in a docker container.
- [Running a macOS VM](https://docs.bluebubbles.app/server/advanced/macos-virtualization/running-a-macos-vm.md)
- [Deploying macOS in VMWare on Windows (Full Guide)](https://docs.bluebubbles.app/server/advanced/macos-virtualization/running-a-macos-vm/deploying-macos-in-vmware-on-windows-full-guide.md)
- [Enabling iMessage in a VM](https://docs.bluebubbles.app/server/advanced/macos-virtualization/running-a-macos-vm/enabling-imessage-in-a-vm.md): How to enable iMessage after successfully creating an unofficial Mac device
- [External Guides](https://docs.bluebubbles.app/server/advanced/macos-virtualization/running-a-macos-vm/external-guides.md)
- [Running BlueBubbles in Docker-OSX](https://docs.bluebubbles.app/server/advanced/macos-virtualization/running-bluebubbles-in-docker-osx.md): This tutorial will show you how you can setup BlueBubbles in a Docker container, within a Linux host.
- [Configuring BlueBubbles as a Service](https://docs.bluebubbles.app/server/advanced/macos-virtualization/running-bluebubbles-in-docker-osx/configuring-bluebubbles-as-a-service.md): This guide will show you how to setup the BlueBubbles Docker container to run as a service on your Linux host. This is to make sure that the host starts up when your Linux host restarts.
- [BYO Proxy Service Guides](https://docs.bluebubbles.app/server/advanced/byo-proxy-service-guides.md): Here you will find child guides for setting up BlueBubbles with a BYO (Bring Your Own) Proxy Service (Dynamic DNS).
- [Cloudflare with a Custom Domain](https://docs.bluebubbles.app/server/advanced/byo-proxy-service-guides/cloudflare-with-a-custom-domain.md)
- [Caddy & DuckDNS](https://docs.bluebubbles.app/server/advanced/byo-proxy-service-guides/caddy-and-duckdns.md): A way to get https when portforwarding with bluebubbles
- [Nginx Proxy Manager](https://docs.bluebubbles.app/server/advanced/byo-proxy-service-guides/nginx-proxy-manager.md): This guide will show you how to setup your own dynamic DNS using your own self-hosted server, running Nginx Proxy Manager
- [Nginx Manual Setup](https://docs.bluebubbles.app/server/advanced/byo-proxy-service-guides/nginx-manual-setup.md): If you want to perform a manual setup of Nginx, instead of using the Nginx Proxy Manager, here is a guide on how to do it. Big thanks to @JustBen in the BlueBubbles Discord, for putting this guide tog
- [Tailscale VPN Setup](https://docs.bluebubbles.app/server/advanced/byo-proxy-service-guides/tailscale-vpn-setup.md)
- [zrok Proxy Service](https://docs.bluebubbles.app/server/advanced/byo-proxy-service-guides/zrok-proxy.md)
- [Developer Guides - Overview](https://docs.bluebubbles.app/server/developer-guides/developer-guides-overview.md): Here you will find guides on how to develop against BlueBubbles
- [Build Yourself / Contribution Guide](https://docs.bluebubbles.app/server/developer-guides/build-yourself-contribution-guide.md): How to build the server on your own system, or how to contribute to the project
- [REST API & Webhooks](https://docs.bluebubbles.app/server/developer-guides/rest-api-and-webhooks.md): Documentation for BlueBubbles REST API & Webhooks
- [Simple Web Server for Webhooks](https://docs.bluebubbles.app/server/developer-guides/simple-web-server-for-webhooks.md): This page will show you how you can create a simple HTTP web server to receive webhooks from the BlueBubbles Server.
- [Python Web Server Example](https://docs.bluebubbles.app/server/developer-guides/simple-web-server-for-webhooks/python-web-server.md): Here is a sample of a web server written in Python to receive new message events.


---

# 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, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.bluebubbles.app/server/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
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.
