Parcourir la source

Document docker setup more explicitly

Vecna il y a 1 mois
Parent
commit
9aefeeb9f1
1 fichiers modifiés avec 37 ajouts et 4 suppressions
  1. 37 4
      README.md

+ 37 - 4
README.md

@@ -30,16 +30,49 @@ The results in the paper were computed using one [Intel Xeon Platinum 8380](http
 ### Software Requirements
 
 Dependencies:
-- bash
 - curl
-- docker
+- docker (provided by the docker.io package on Debian/Ubuntu)
 - git
 
 We used Ubuntu 22.04 for our host OS, but any Linux distribution should work.
 
-Docker must be installed. (On Ubuntu 22.04, for example, run `sudo apt install docker.io`.) We used Docker version 29.1.3.
+In addition to installing the dependencies, ensure that your user is in the docker group. For example, on Ubuntu 22.04:
 
-We use the rust:1.93.0 as the base Docker image for our experiments. Other dependencies are installed within Docker images.
+1. `sudo apt update`
+2. `sudo apt install curl docker.io git`
+3. `sudo usermod -aG docker $(whoami)`
+4. Log out and log back in
+
+Run `docker run hello-world` to test that Docker is working properly. The output should be something like this:
+
+    Unable to find image 'hello-world:latest' locally
+    latest: Pulling from library/hello-world
+    4f55086f7dd0: Pull complete 
+    Digest: sha256:0e760fdfbc48ba8041e7c6db999bb40bfca508b4be580ac75d32c4e29d202ce1
+    Status: Downloaded newer image for hello-world:latest
+
+    Hello from Docker!
+    This message shows that your installation appears to be working correctly.
+
+    To generate this message, Docker took the following steps:
+     1. The Docker client contacted the Docker daemon.
+     2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
+        (amd64)
+     3. The Docker daemon created a new container from that image which runs the
+        executable that produces the output you are currently reading.
+     4. The Docker daemon streamed that output to the Docker client, which sent it
+        to your terminal.
+
+    To try something more ambitious, you can run an Ubuntu container with:
+     $ docker run -it ubuntu bash
+
+    Share images, automate workflows, and more with a free Docker ID:
+     https://hub.docker.com/
+
+    For more examples and ideas, visit:
+     https://docs.docker.com/get-started/
+
+We used Docker version 29.1.3 with rust:1.93.0 as the base Docker image for our experiments. Other dependencies are installed within Docker images.
 
 ### Estimated Time and Storage Consumption