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

# 使用 GitHub Codespace

測試 Ayakaleaf Pro 最簡單的方式是使用 GitHub Codespace，所有環境變數皆已預先設定，確保您能開箱即用。

<Warning>
  當您使用 GitHub Codespaces 執行 Docker 容器時，Codespace 不會自動關閉，並將持續**計費**。關於 GitHub Codespaces 的計費規則，請參閱 [github codespaces 計費規則](https://docs.github.com/en/billing/concepts/product-billing/github-codespaces)。

  若要管理您的 GitHub Codespaces，請前往 [https://github.com/codespaces](https://github.com/codespaces)。當您不再需要時，請及時刪除您的 Codespace。
</Warning>

我們已**預先設定**以下功能：

* [x] 使用 TeXLive **Basic**（2024-2026）的沙箱化 LaTeX 編譯
* [x] Pandoc 匯入／匯出（SaaS 平台功能）
* [x] Python 腳本執行器（SaaS 平台功能）
* [x] Git-Bridge 支援（Server Pro 功能）
* [x] 進階參考文獻搜尋（SaaS 平台功能）
* [x] 管理面板（全域使用者／專案管理）
* [x] 追蹤修訂（含審閱與留言面板）
* [x] 完整專案歷程記錄（含還原與下載）
* [x] 符號面板（Server Pro／SaaS 平台功能）

<Warning>
  標準 GitHub Codespaces 提供 32 GB 的儲存空間，這對於我們的 `texlive-full` 安裝來說並不足夠。若要測試完整映像檔，請提交 GitHub 支援工單，申請使用大型執行器（8 核心以上）的 Codespace。
</Warning>

GitHub 同步、LDAP、OAuth、SSO、Zotero 整合及其他功能在此試用環境中\_**並未設定**\_。您可以參考 [toolkit 設定](/zh-TW/on-premises/configuration/overleaf-toolkit/toolkit-settings)，了解如何在您自己的部署中設定這些功能。

<Steps>
  <Step title="建立您的 GitHub Codespace">
    點選下方按鈕以建立您的 GitHub Codespace。在伺服器設定方面，**2 核心搭配 8 GB 記憶體**通常足以應付測試情境。如果您打算使用 [**TeX Live Full**](https://github.com/ayaka-notes/texlive-full)，建議選擇 **8 核心 64GB** 的設定。

    [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/ayaka-notes/ayakaleaf-pro-playground)
  </Step>

  <Step title="初始化 Overleaf 執行個體">
    當您的 Codespace 準備就緒後，在 bash 中執行以下指令以初始化您的 Overleaf 執行個體。

    ```bash title="bash" theme={null}
    ./init.sh
    ```

    <Info>
      您可能需要等待至少 3 分鐘，讓我們拉取您所需的所有 Docker 映像檔。
    </Info>

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-26.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=8566b61de0757c1b270e7e5011d48a3e" alt="" width="1181" height="626" data-path="images/on-premises/image-26.png" />
    </Frame>
  </Step>

  <Step title="開放連接埠 80">
    切換到 **Ports** 分頁，然後依照以下步驟將連接埠 80 設為公開。

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/GmaXa-Cu4QQRFT4C/images/on-premises/img-db37d3e4.png?fit=max&auto=format&n=GmaXa-Cu4QQRFT4C&q=85&s=81e5a18f3aebbd396a57d163a2460739" alt="" width="1452" height="694" data-path="images/on-premises/img-db37d3e4.png" />
    </Frame>

    之後，您可以點選 **Forwarded Address** 來造訪您的 Overleaf 執行個體。您可能需要加上 `/launchpad` 才能造訪 Overleaf 歡迎頁面。
  </Step>

  <Step title="建立您的管理員帳號">
    輸入您的管理員帳號與密碼，然後點選 Register 按鈕。

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/img-1ae40ae0.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=82d769561891fd4b4566ee2ad9c48065" alt="" width="2736" height="1798" data-path="images/on-premises/img-1ae40ae0.png" />
    </Frame>
  </Step>

  <Step title="盡情寫作">
    現在，盡情享受您的 $\LaTeX$ 寫作吧！

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-25.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=1d4e1fac863cbee906d9d3ad2f3c08d7" alt="" width="2104" height="1415" data-path="images/on-premises/image-25.png" />
    </Frame>
  </Step>
</Steps>

#### 使用 TeXLive Full 映像檔

如果您可以使用 8 核心／64 GB 的 GitHub Codespaces，即可在此試用環境中使用 TeXLive Full 映像檔。您可以在 `toolkit/config/variables.env` 檔案中變更以下環境變數，改用 TeXLive Full 映像檔取代 TeXLive Basic 映像檔。

```dotenv wrap theme={null}
ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2026.1, ghcr.io/ayaka-notes/texlive-full:2025.1, ghcr.io/ayaka-notes/texlive-full:2024.1
ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2026, Texlive 2025, Texlive 2024
TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2026.1
```

變更環境變數後，您需要重新啟動 toolkit 以套用變更。您可以執行以下指令來重新啟動 toolkit。

```bash theme={null}
cd toolkit && bin/up -d
```


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