> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# macOS

> Run a local Ayakaleaf Pro instance on macOS with Docker Desktop and the Toolkit.

In this section we run Ayakaleaf Pro locally on your Mac with Docker Desktop and the [Ayakaleaf Toolkit](https://github.com/ayaka-notes/toolkit). The guide uses `http://localhost:8080`, keeps the data in your home directory, and compiles with TeX Live 2026 in sandboxed containers.

Docker Desktop runs the application, MongoDB, Redis and the TeX Live compiler in a Linux virtual machine. You don't install MongoDB, Redis or MacTeX on macOS itself.

Use this setup for personal use and local testing. For an always-on shared service, we recommend the [Linux guide](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/linux), with HTTPS, backups and access control. The instance is unavailable while the Mac sleeps or Docker Desktop is stopped, see [Keep the instance available](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/macos/6.-post-installation-tasks.md#keep-the-instance-available).

## Before you start

You need:

* A macOS version supported by [Docker Desktop for Mac](https://docs.docker.com/desktop/setup/install/mac-install/).
* Git, [Homebrew](https://brew.sh/) and GNU sed. The Toolkit uses GNU sed options that the BSD sed built into macOS does not accept.
* Enough resources for both macOS and Docker. For a small local instance, start with 4 CPUs and 8 GB of memory allocated to Docker Desktop. This is a suggested starting point, not a measured minimum.
* At least 40 GB of free storage for a full TeX Live image, plus space for your projects. Check both the free space on the Mac and Docker Desktop's disk usage limit. Start with one TeX Live version: every additional version needs about as much space again.

The application and TeX Live images are published for `arm64` and `amd64`. On Apple silicon, let Docker pick the native ARM image and do not force `platform: linux/amd64`.

## Steps

> [card] [0. Setup Docker Desktop](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/macos/0.-setup-docker-desktop.md)

> [card] [1. Download the Toolkit](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/macos/1.-download-the-toolkit.md)

> [card] [2. Familiarize yourself with the Toolkit](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/macos/2.-familiarize-yourself-with-the-toolkit.md)

> [card] [3. Initialize the configuration](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/macos/3.-initialize-the-configuration.md)

> [card] [4. Get Ayakaleaf Pro Images](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/macos/4.-get-ayakaleaf-pro-images.md)

> [card] [5. Personalizing your instance](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/macos/5.-personalizing-your-instance.md)

> [card] [6. Post-installation tasks](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/macos/6.-post-installation-tasks.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.