diff --git a/docs/modules/user/pages/quickstart.adoc b/docs/modules/user/pages/quickstart.adoc index b0f0811d..8476355c 100644 --- a/docs/modules/user/pages/quickstart.adoc +++ b/docs/modules/user/pages/quickstart.adoc @@ -57,123 +57,7 @@ services: .... -- -Nvidia (Container Toolkit):: -+ --- - -Unfortunately, on Nvidia, things are a little bit more complex: - -* Your driver version must be `>= 530.30.02` -* Make sure to install https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html[NVIDIA Container Toolkit] - -We also have to make sure that the `nvidia-drm` module has been loaded and that is loaded with the flag `modeset=1`. - -[source,bash] -.... -sudo cat /sys/module/nvidia_drm/parameters/modeset -Y -.... - -.I get `N` or the file is not present, how do I set the flag? -[%collapsible] -==== - -If using Grub, the easiest way to make the change persistent is to add `nvidia-drm.modeset=1` to the `GRUB_CMDLINE_LINUX_DEFAULT` line in `/etc/default/grub` ex: - -.... -GRUB_CMDLINE_LINUX_DEFAULT="quiet nvidia-drm.modeset=1" -.... - -Then `sudo update-grub` and *reboot*. - -For more options or details, you can see https://wiki.archlinux.org/title/Kernel_parameters[ArchWiki: Kernel parameters] - -==== - -Docker CLI: - -[source,bash] -.... -docker run \ - --rm \ - --name wolf \ - --network=host \ - -e WOLF_LOG_LEVEL=DEBUG \ - -e XDG_RUNTIME_DIR=/tmp/sockets \ - -v /tmp/sockets:/tmp/sockets:rw \ - -e HOST_APPS_STATE_FOLDER=/etc/wolf \ - -v /etc/wolf/wolf:/wolf/cfg \ - -v /var/run/docker.sock:/var/run/docker.sock:rw \ - --gpus=all \ - --device-cgroup-rule "c 13:* rmw" \ - --device /dev/dri/ \ - --device /dev/uinput \ - -v /dev/shm:/dev/shm:rw \ - -v /dev/input:/dev/input:rw \ - -v /run/udev:/run/udev:rw \ - -v /etc/wolf/ensure-groups:/opt/gow/ensure-groups:rw \ - ghcr.io/games-on-whales/wolf:stable -.... - -Docker compose: - -[source,yaml] -.... -version: "3.8" -services: - wolf: - image: ghcr.io/games-on-whales/wolf:stable - environment: - - XDG_RUNTIME_DIR=/tmp/sockets - - HOST_APPS_STATE_FOLDER=/etc/wolf - volumes: - - /etc/wolf/wolf:/wolf/cfg - - /tmp/sockets:/tmp/sockets:rw - - /var/run/docker.sock:/var/run/docker.sock:rw - - /dev/shm:/dev/shm:rw - - /dev/input:/dev/input:rw - devices: - - /dev/dri - - /dev/uinput - device_cgroup_rules: - - 'c 13:* rmw' - deploy: - resources: - reservations: - devices: - - driver: nvidia - count: 1 - capabilities: [gpu] - network_mode: host - restart: unless-stopped -.... - -You can check if the driver is loaded by issuing `nvidia-smi` inside the container: -[source,bash] -.... -docker exec -it wolf nvidia-smi -+---------------------------------------------------------------------------------------+ -| NVIDIA-SMI 530.30.02 Driver Version: 530.30.02 CUDA Version: 12.1 | -|-----------------------------------------+----------------------+----------------------+ -| GPU Name Persistence-M| Bus-Id Disp.A | Volatile Uncorr. ECC | -| Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. | -| | | MIG M. | -|=========================================+======================+======================| -| 0 NVIDIA GeForce RTX 3070 On | 00000000:0A:00.0 Off | N/A | -| 0% 47C P8 16W / 220W| 416MiB / 8192MiB | 0% Default | -| | | N/A | -+-----------------------------------------+----------------------+----------------------+ - -+---------------------------------------------------------------------------------------+ -| Processes: | -| GPU GI CI PID Type Process name GPU Memory | -| ID ID Usage | -|=======================================================================================| -+---------------------------------------------------------------------------------------+ -.... - --- -Nvidia (Manual):: +Nvidia:: + -- @@ -302,14 +186,16 @@ volumes: external: true .... -Depending on your system you might also need to initialise the `nvidia-uvm` devices: +If you are missing any of the `/dev/nvidia*` devices you might also need to initialise them using: [source,bash] .... sudo nvidia-container-cli --load-kmods info .... -Or if that fails: +.Or if that fails: +[%collapsible] +==== [source,bash] .... @@ -342,6 +228,7 @@ else exit 1 fi .... +==== --