> ## 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.

# Windows

> Run a local Ayakaleaf Pro instance on Windows with WSL 2, Docker Desktop and the Toolkit.

In this section we run Ayakaleaf Pro locally on Windows with WSL 2, Ubuntu, Docker Desktop and the [Ayakaleaf Toolkit](https://github.com/ayaka-notes/toolkit). The guide uses `http://localhost:8080`, keeps data in Ubuntu's home directory, and enables sandboxed compiles.

The application, MongoDB, Redis and TeX Live run in Linux containers managed by Docker Desktop. Run Toolkit commands in Ubuntu; open the application in your Windows browser. [Step 0](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/windows/0.-setup-wsl-and-docker-desktop.md) explains how the Windows and Linux parts fit together and starts from installing WSL.

You can use Windows for a local instance or keep it running continuously with the availability settings in step 6. For shared and production servers, we recommend the [Linux guide](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/linux), with HTTPS, backups and access control. Windows sleep, Docker Desktop shutdown and WSL shutdown interrupt this local instance; see [Keep the instance available](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/windows/6.-post-installation-tasks.md#keep-the-instance-available).

## Before you start

You need:

* A Windows version and processor supported by [Docker Desktop for Windows](https://docs.docker.com/desktop/setup/install/windows-install/), with hardware virtualization enabled. This guide uses Windows 11 on x86-64.
* Permission to enable WSL and install software. WSL must be version 2.1.5 or later, with Ubuntu running in WSL 2 mode.
* Enough memory for Windows and the containers. For a small local instance, 4 CPUs and 8 GB available to Docker are a suggested starting point, not a measured minimum.
* Free storage on the Windows disk holding WSL and Docker data. Allow at least 40 GB for a full TeX Live setup plus project data; the basic image in [step 5](https://ayakaleaf-pro.mintlify.site/on-premises/installation/using-docker-compose/windows/5.-personalizing-your-instance.md) is smaller and suitable for the initial deployment test. Additional image versions need additional space.
* Network access to GitHub, GitHub Container Registry (`ghcr.io`) and Docker Hub to clone the Toolkit and download images.

**PowerShell** blocks run in Windows. **Bash** blocks and `bin/` commands run in Ubuntu unless stated otherwise. Do not run Toolkit scripts in PowerShell or Windows Git Bash.

## Steps

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

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

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

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

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

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

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


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