Update README to use 'cua-xfce' instead of 'cua-docker-xfce'

This commit is contained in:
ddupont
2025-10-21 10:11:53 -07:00
committed by GitHub
parent 82d204f72f
commit 93e64cb58c

View File

@@ -38,7 +38,7 @@ Vanilla XFCE desktop container for Computer-Using Agents (CUA) with noVNC and co
## Building the Container
```bash
docker build -t cua-docker-xfce:latest .
docker build -t cua-xfce:latest .
```
### Build and Push (multi-arch)
@@ -67,7 +67,7 @@ docker run --rm -it \
-p 5901:5901 \
-p 6901:6901 \
-p 8000:8000 \
cua-docker-xfce:latest
cua-xfce:latest
```
### With Custom Resolution
@@ -79,7 +79,7 @@ docker run --rm -it \
-p 6901:6901 \
-p 8000:8000 \
-e VNC_RESOLUTION=1280x720 \
cua-docker-xfce:latest
cua-xfce:latest
```
### With Persistent Storage
@@ -91,7 +91,7 @@ docker run --rm -it \
-p 6901:6901 \
-p 8000:8000 \
-v $(pwd)/storage:/home/cua/storage \
cua-docker-xfce:latest
cua-xfce:latest
```
## Accessing the Container
@@ -102,16 +102,16 @@ docker run --rm -it \
## Using with CUA Docker Provider
This container is designed to work with the CUA Docker provider. Simply specify the docker-xfce image:
This container is designed to work with the CUA Docker provider. Simply specify the xfce image:
```python
from computer import Computer
# Create computer with docker-xfce container
# Create computer with xfce container
computer = Computer(
os_type="linux",
provider_type="docker",
image="trycua/cua-xfce:latest", # Use docker-xfce instead of Kasm
image="trycua/cua-xfce:latest", # Use xfce instead of Kasm
display="1024x768",
memory="4GB",
cpu="2"
@@ -131,7 +131,7 @@ async with computer:
print(result.stdout)
```
### Switching between Kasm and docker-xfce
### Switching between Kasm and xfce
The Docker provider automatically detects which image you're using:
@@ -143,11 +143,11 @@ computer_kasm = Computer(
image="trycua/cua-ubuntu:latest", # Kasm image
)
# Use docker-xfce container (vanilla XFCE)
# Use xfce container (vanilla XFCE)
computer_xfce = Computer(
os_type="linux",
provider_type="docker",
image="trycua/cua-xfce:latest", # docker-xfce image
image="trycua/cua-xfce:latest", # xfce image
)
```
@@ -186,7 +186,7 @@ Both provide the same API and functionality - the provider automatically configu
### Filesystem Snapshot
```bash
docker commit <container_id> cua-docker-xfce-snapshot:latest
docker commit <container_id> cua-xfce-snapshot:latest
```
### Running from Snapshot
@@ -195,7 +195,7 @@ docker run --rm -it \
--shm-size=512m \
-p 6901:6901 \
-p 8000:8000 \
cua-docker-xfce-snapshot:latest
cua-xfce-snapshot:latest
```
## Comparison with Kasm Container