diff --git a/docs/content/docs/libraries/lumier/docker.mdx b/docs/content/docs/libraries/lumier/docker.mdx new file mode 100644 index 00000000..3038f1c9 --- /dev/null +++ b/docs/content/docs/libraries/lumier/docker.mdx @@ -0,0 +1,52 @@ +--- +title: Docker +--- + +You can use Lumier through Docker: + +### Run a macOS VM (ephemeral) +```bash +docker run -it --rm \ + --name macos-vm \ + -p 8006:8006 \ + -e VM_NAME=macos-vm \ + -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ + -e CPU_CORES=4 \ + -e RAM_SIZE=8192 \ + trycua/lumier:latest +``` +Access the VM in your browser at [http://localhost:8006](http://localhost:8006). + +### Persistent Storage +```bash +mkdir -p storage + +docker run -it --rm \ + --name lumier-vm \ + -p 8006:8006 \ + -v $(pwd)/storage:/storage \ + -e VM_NAME=lumier-vm \ + -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ + -e CPU_CORES=4 \ + -e RAM_SIZE=8192 \ + -e HOST_STORAGE_PATH=$(pwd)/storage \ + trycua/lumier:latest +``` + +### Shared Folder +```bash +mkdir -p shared + +docker run -it --rm \ + --name lumier-vm \ + -p 8006:8006 \ + -v $(pwd)/storage:/storage \ + -v $(pwd)/shared:/shared \ + -e VM_NAME=lumier-vm \ + -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ + -e CPU_CORES=4 \ + -e RAM_SIZE=8192 \ + -e HOST_STORAGE_PATH=$(pwd)/storage \ + -e HOST_SHARED_PATH=$(pwd)/shared \ + trycua/lumier:latest +``` \ No newline at end of file diff --git a/docs/content/docs/libraries/lumier/index.mdx b/docs/content/docs/libraries/lumier/index.mdx index 3858504d..55e113e9 100644 --- a/docs/content/docs/libraries/lumier/index.mdx +++ b/docs/content/docs/libraries/lumier/index.mdx @@ -5,65 +5,9 @@ github: - https://github.com/trycua/cua/tree/main/libs/lumier --- -## Overview +**Lumier** is an interface for running macOS virtual machines with minimal setup. It uses Docker as a packaging system to deliver a pre-configured environment that connects to the `lume` virtualization service running on your host machine. With Lumier, you get: -The Lumier library provides a Docker-based interface for creating performant macOS virtual machines. - -## Installation - -**Requirements:** -- Docker for Apple Silicon (or compatible Mac) -- Lume virtualization CLI (install with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)"`) - -## Usage - -### Run a macOS VM (ephemeral) -```bash -docker run -it --rm \ - --name macos-vm \ - -p 8006:8006 \ - -e VM_NAME=macos-vm \ - -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ - -e CPU_CORES=4 \ - -e RAM_SIZE=8192 \ - trycua/lumier:latest -``` -Access the VM in your browser at [http://localhost:8006](http://localhost:8006). - -### Persistent Storage -```bash -mkdir -p storage - -docker run -it --rm \ - --name lumier-vm \ - -p 8006:8006 \ - -v $(pwd)/storage:/storage \ - -e VM_NAME=lumier-vm \ - -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ - -e CPU_CORES=4 \ - -e RAM_SIZE=8192 \ - -e HOST_STORAGE_PATH=$(pwd)/storage \ - trycua/lumier:latest -``` - -### Shared Folder -```bash -mkdir -p shared - -docker run -it --rm \ - --name lumier-vm \ - -p 8006:8006 \ - -v $(pwd)/storage:/storage \ - -v $(pwd)/shared:/shared \ - -e VM_NAME=lumier-vm \ - -e VERSION=ghcr.io/trycua/macos-sequoia-cua:latest \ - -e CPU_CORES=4 \ - -e RAM_SIZE=8192 \ - -e HOST_STORAGE_PATH=$(pwd)/storage \ - -e HOST_SHARED_PATH=$(pwd)/shared \ - trycua/lumier:latest -``` - ---- - -See the [Lumier README](https://github.com/trycua/cua/tree/main/libs/lumier) for advanced options, Docker Compose setup, and automation scripts. \ No newline at end of file +- A ready-to-use macOS or Linux virtual machine in minutes +- Browser-based VNC access to your VM +- Easy file sharing between your host and VM +- Simple configuration through environment variables \ No newline at end of file diff --git a/docs/content/docs/libraries/lumier/installation.mdx b/docs/content/docs/libraries/lumier/installation.mdx new file mode 100644 index 00000000..63db702a --- /dev/null +++ b/docs/content/docs/libraries/lumier/installation.mdx @@ -0,0 +1,7 @@ +--- +title: Installation +--- + +**Requirements:** +- Docker for Apple Silicon (or compatible Mac) +- Lume virtualization CLI (install with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/trycua/cua/main/libs/lume/scripts/install.sh)"`) \ No newline at end of file diff --git a/docs/content/docs/libraries/lumier/meta.json b/docs/content/docs/libraries/lumier/meta.json new file mode 100644 index 00000000..a24ac050 --- /dev/null +++ b/docs/content/docs/libraries/lumier/meta.json @@ -0,0 +1,7 @@ +{ + "pages": [ + "installation", + "docker", + "docker-compose" + ] +}