Merge Docker guidelines into Readme

This commit is contained in:
FredWuCZ
2024-10-22 22:34:22 +08:00
parent 275de550b4
commit 278fe6b7c9
2 changed files with 0 additions and 32 deletions

View File

@@ -90,9 +90,6 @@ Add the following arguments when initializing `DesktopEnv`:
- `provider`: `docker`
- `os_type`: `Ubuntu` or `Windows`, depending on the OS of the VM
See [DOCKER_GUIDELINE](https://github.com/xlang-ai/OSWorld/blob/main/desktop_env/providers/docker/DOCKER_GUIDELINE.md) for more details of using Docker to host virtual machines.
### Others
We are working on supporting more 👷. Please hold tight!

View File

@@ -1,29 +0,0 @@
# Configuration of Docker
---
Welcome to the Docker VM Management documentation.
## Prerequisite: Check if your machine supports KVM
We recommend running the VM with KVM support. To check if your hosting platform supports KVM, run
```
egrep -c '(vmx|svm)' /proc/cpuinfo
```
on Linux. If the return value is greater than zero, the processor should be able to support KVM.
> **Note**: macOS hosts generally do not support KVM.
## Install Docker
If your hosting platform supports graphical user interface (GUI), you may refer to [Install Docker Desktop on Linux](https://docs.docker.com/desktop/install/linux/) or [Install Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/) based on your OS. Otherwise, you may [Install Docker Engine](https://docs.docker.com/engine/install/).
## Running Experiments
Add the following arguments when initializing `DesktopEnv`:
- `provider`: `docker`
- `os_type`: `Ubuntu` or `Windows`, depending on the OS of the VM
Please allow for some time to download the virtual machine snapshot on your first run.