跳转到主要内容

创建管理员和第一个项目

在你的 Windows 浏览器中打开 http://localhost:8080/launchpad,创建第一个管理员账户并登录。然后按照 Linux 指南的 6. 安装后任务 操作,并在其示例 URL 中使用端口 8080。

验证编译

登录页面能够正常工作,并不能证明独立的编译器容器可以访问 WSL 数据目录。请创建一个空白项目,并使用 pdfLaTeX 编译以下 main.tex:
PDF 预览中应显示该文本。如果使用 basic 镜像,必要时请在项目设置中选择 TeX Live 2026 Basic。 选择 XeLaTeX 并测试:
这两个示例都可以在 basic 镜像下运行。对于中文文档,请先使用包含 ctex 和所需字体的镜像(例如 full),再使用 XeLaTeX 测试以下内容。basic 镜像不包含这些内容:
要确认使用了沙盒,请在编译时在 Ubuntu 中运行:
请在过滤器中使用你所选择的镜像名称。较短的编译可能在 docker ps 运行之前就已完成;-a 还会显示已停止但尚未清理的容器。编译器容器应使用该镜像,并带有一个来自 Toolkit 的 WSL 数据目录的 /compile 绑定挂载。仅查看应用程序日志并不能代替检查 PDF。

验证数据持久化

在 Ubuntu 中,从 Toolkit 目录运行:
等待应用程序启动后,从 Windows 重新打开该项目并再次编译。你的账户、源文件和项目文件应该都还在。默认的实时数据位于 Ubuntu 中的 ~/ayakaleaf-toolkit/data/。请同时保留 config/ 和 data/;卸载或注销 Ubuntu 发行版可能会删除它们。

保持实例可用

让实例保持运行涉及三个方面:Windows 保持唤醒、Docker Desktop 保持运行,以及容器随引擎一起重启。 在 Docker Desktop 的 Settings → General 中,开启 Start Docker Desktop when you sign in to your computer,请参阅 Docker Desktop 设置。这会在登录后启动 Docker,而不是在登录前。Windows 重启后,请登录,等待 Docker Desktop 完成启动,然后打开 Ubuntu 并检查 docker ps 和站点。 Docker Desktop 的 Resource Saver 与 Windows 睡眠是两回事。它通常只在没有容器运行时才会启用;正在运行的应用程序、MongoDB 和 Redis 会阻止进入这种空闲状态。在 WSL 2 上,它会暂停 Docker 引擎,而不是关闭共享的 WSL 虚拟机。在为用户提供服务期间,不要手动 Pause Docker Desktop。你无需仅仅为了让此栈保持运行而禁用 Resource Saver;请参阅 Docker 的 Resource Saver 文档。 Toolkit 的服务使用 restart: always。请在 Ubuntu 中验证实际设置:
每个服务都应报告 always。Docker 运行后,它可以重新启动这些已有的容器,而无需再次运行 bin/up。手动停止的容器会保持停止状态,直到你启动它或重启引擎;在 always 策略下,引擎重启可能会再次启动它。请参阅 Docker 的重启策略行为。 如需在接通交流电源时长时间运行,请打开 Windows 11 的 Settings → System → Power & battery → Screen, sleep & hibernate timeouts(设置 → 系统 → 电源和电池 → 屏幕、睡眠和休眠超时;某些版本显示为 Power 或 Screen and sleep)。将接通电源时的睡眠超时设置为 Never(从不),如果配置了自动休眠,也请将其禁用。显示器仍然可以关闭。笔记本电脑的合盖操作是另一项单独的设置;即使空闲睡眠超时设置为从不,合上盖子也可能使其进入睡眠。请参阅 Windows 电源设置。 在站点使用期间,不要将运行 wsl --shutdown 作为日常清理操作。如果某项 WSL 设置更改需要它,请先停止实例并规划好中断时间。通过这些设置,Windows 可以持续运行该实例。对于必须在注销和无人值守重启后仍能保持运行的共享服务,我们推荐使用 Linux 指南。

重启 Docker Desktop 后检查恢复情况

在保存工作并等待正在进行的编译完成后,从 Docker Desktop 的故障排除菜单中选择 Restart Docker Desktop。等待引擎启动,然后在 Ubuntu 中检查:
在 Windows 中打开已有的项目并再次编译。确认账户和源文件仍然存在。 如果你是使用 bin/stop 有意停止实例的,请使用 bin/start。如果 Docker 已运行但某个服务失败,请查看其日志,而不是重新创建配置。Windows 更新、Docker 更新和断电仍可能中断 24 小时运行的安装;请保留备份,并在计划内维护之后检查恢复情况。

日常使用

在 Windows 中启动 Docker Desktop。打开 Ubuntu:
bin/start 不会应用配置的修改:更改 config/ 后请使用 bin/up -d。在升级、迁移或删除 WSL 发行版之前,请按照数据和备份操作。在数据库写入时复制实时 MongoDB 文件,并不能得到一致的备份。 本地使用时请保持 127.0.0.1。如需为其他计算机提供服务,还需要有意识地配置监听地址、站点 URL、Windows 防火墙/网络配置和 HTTPS;仅更改 OVERLEAF_SITE_URL 并不会发布端口。 如果遇到问题,请参阅故障排除。
最后修改于 2026年11月8日