From 667f35a3139da8ce426eb8bf8a0df7dde2044675 Mon Sep 17 00:00:00 2001 From: James Murdza Date: Wed, 27 Aug 2025 21:27:35 -0400 Subject: [PATCH] Add prebuilt images page --- .../docs/libraries/lume/cli-reference.mdx | 2 +- docs/content/docs/libraries/lume/meta.json | 3 ++- .../docs/libraries/lume/prebuilt-images.mdx | 20 +++++++++++++++++++ 3 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 docs/content/docs/libraries/lume/prebuilt-images.mdx diff --git a/docs/content/docs/libraries/lume/cli-reference.mdx b/docs/content/docs/libraries/lume/cli-reference.mdx index f532c1a1..5afcc7fe 100644 --- a/docs/content/docs/libraries/lume/cli-reference.mdx +++ b/docs/content/docs/libraries/lume/cli-reference.mdx @@ -18,7 +18,7 @@ lume run ubuntu-noble-vanilla:latest ``` -We provide prebuilt VM images in our [ghcr registry](https://github.com/orgs/trycua/packages). +We provide [prebuilt VM images](../lume/prebuilt-images) in our [ghcr registry](https://github.com/orgs/trycua/packages). ### Create a Custom VM diff --git a/docs/content/docs/libraries/lume/meta.json b/docs/content/docs/libraries/lume/meta.json index dbca49ea..3b274f24 100644 --- a/docs/content/docs/libraries/lume/meta.json +++ b/docs/content/docs/libraries/lume/meta.json @@ -1,7 +1,8 @@ { "pages": [ "installation", - "cli-reference", + "prebuilt-images", + "cli-reference", "http-api" ] } diff --git a/docs/content/docs/libraries/lume/prebuilt-images.mdx b/docs/content/docs/libraries/lume/prebuilt-images.mdx new file mode 100644 index 00000000..0120af43 --- /dev/null +++ b/docs/content/docs/libraries/lume/prebuilt-images.mdx @@ -0,0 +1,20 @@ +--- +title: Prebuilt Images +--- + +Pre-built images are available in the registry [ghcr.io/trycua](https://github.com/orgs/trycua/packages). + +**Important Note (v0.2.0+):** Images are being re-uploaded with sparse file system optimizations enabled, resulting in significantly lower actual disk usage. Older images (without the `-sparse` suffix) are now **deprecated**. The last version of `lume` fully supporting the non-sparse images was `v0.1.x`. Starting from `v0.2.0`, lume will automatically pull images optimized with sparse file system support. + +These images come with an SSH server pre-configured and auto-login enabled. + +For the security of your VM, change the default password `lume` immediately after your first login. + +| Image | Tag | Description | Logical Size | +|-------|------------|-------------|------| +| `macos-sequoia-vanilla` | `latest`, `15.2` | macOS Sequoia 15.2 image | 20GB | +| `macos-sequoia-xcode` | `latest`, `15.2` | macOS Sequoia 15.2 image with Xcode command line tools | 22GB | +| `macos-sequoia-cua` | `latest`, `15.3` | macOS Sequoia 15.3 image compatible with the Computer interface | 24GB | +| `ubuntu-noble-vanilla` | `latest`, `24.04.1` | [Ubuntu Server for ARM 24.04.1 LTS](https://ubuntu.com/download/server/arm) with Ubuntu Desktop | 20GB | + +For additional disk space, resize the VM disk after pulling the image using the `lume set --disk-size ` command. Note that the actual disk space used by sparse images will be much lower than the logical size listed. \ No newline at end of file