Merge pull request #467 from trycua/fix/docker-nits

Add multiplatform build docs for Docker images, fix incorrect image name
This commit is contained in:
James Murdza
2025-10-16 14:37:13 -07:00
committed by GitHub
3 changed files with 23 additions and 23 deletions

View File

@@ -13,23 +13,20 @@ Containerized virtual desktop for Computer-Using Agents (CUA). Utilizes Kasm's M
## Usage
### Building the Container
### Build and Push (multi-arch)
Use Docker Buildx to build and push a multi-architecture image for both `linux/amd64` and `linux/arm64` in a single command. Replace `trycua` with your Docker Hub username or your registry namespace as needed.
```bash
docker build -t cua-ubuntu:latest .
```
### Pushing to Registry
```bash
# Tag for Docker Hub (replace 'trycua' with your Docker Hub username)
docker tag cua-ubuntu:latest trycua/cua-ubuntu:latest
# Login to Docker Hub
# Login to your registry first (Docker Hub shown here)
docker login
# Push to Docker Hub
docker push trycua/cua-ubuntu:latest
# Build and push for amd64 and arm64 in one step
docker buildx build \
--platform linux/amd64,linux/arm64 \
-t trycua/cua-ubuntu:latest \
--push \
.
```
### Running the Container Manually

View File

@@ -56,7 +56,7 @@ class DockerProvider(BaseVMProvider):
image: Docker image to use (default: "trycua/cua-ubuntu:latest")
Supported images:
- "trycua/cua-ubuntu:latest" (Kasm-based)
- "trycua/cua-docker-xfce:latest" (vanilla XFCE)
- "trycua/cua-xfce:latest" (vanilla XFCE)
verbose: Enable verbose logging
ephemeral: Use ephemeral (temporary) storage
vnc_port: Port for VNC interface (default: 6901)

View File

@@ -41,17 +41,20 @@ Vanilla XFCE desktop container for Computer-Using Agents (CUA) with noVNC and co
docker build -t cua-docker-xfce:latest .
```
## Pushing to Registry
### Build and Push (multi-arch)
Use Docker Buildx to build and push a multi-architecture image for both `linux/amd64` and `linux/arm64` in a single command. Replace `trycua` with your Docker Hub username or your registry namespace as needed.
```bash
# Tag for Docker Hub (replace 'trycua' with your Docker Hub username)
docker tag cua-docker-xfce:latest trycua/cua-docker-xfce:latest
# Login to Docker Hub
# Login to your registry first (Docker Hub shown here)
docker login
# Push to Docker Hub
docker push trycua/cua-docker-xfce:latest
# Build and push for amd64 and arm64 in one step
docker buildx build \
--platform linux/amd64,linux/arm64 \
-t trycua/cua-xfce:latest \
--push \
.
```
## Running the Container Manually
@@ -108,7 +111,7 @@ from computer import Computer
computer = Computer(
os_type="linux",
provider_type="docker",
image="trycua/cua-docker-xfce:latest", # Use docker-xfce instead of Kasm
image="trycua/cua-xfce:latest", # Use docker-xfce instead of Kasm
display="1024x768",
memory="4GB",
cpu="2"
@@ -144,7 +147,7 @@ computer_kasm = Computer(
computer_xfce = Computer(
os_type="linux",
provider_type="docker",
image="trycua/cua-docker-xfce:latest", # docker-xfce image
image="trycua/cua-xfce:latest", # docker-xfce image
)
```