[PR #470] docs(quickstart): add "Nvidia (Auto)" automated driver setup method #486

New issue

Open

opened 2026-10-15 13:00:56 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-15 13:00:56 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/games-on-whales/wolf/pull/470
Author: @piotrminkina
Created: 8/2/2026
Status: 🔄 Open

Base: beta ← Head: feature/nvidia-auto

📝 Commits (1)

c5209bc Add Nvidia auto-install instructions to Quickstart guide

📊 Changes

1 file changed (+64 additions, -1 deletions)

View changed files

📝 docs/modules/user/pages/quickstart.adoc (+64 -1)

📄 Description

What

Adds a third setup method to the Quickstart guide — Nvidia (Auto) — documenting a fully automated Nvidia driver setup that removes the two manual steps the existing Nvidia (Manual) method requires: looking up the host driver version by hand, and re-creating the driver volume after every host driver upgrade.

Changes

docs/modules/user/pages/quickstart.adoc:

New Nvidia (Auto) tab, placed between Nvidia (Container Toolkit) and Nvidia (Manual). It documents a single docker compose up --detach workflow:
- an init-nvidia-driver service builds the gow/nvidia-driver image, receiving the host driver version as a Compose secret sourced from /sys/module/nvidia/version — so the driver in the volume always matches the running kernel module, with no manual version pinning;
- Wolf declares depends_on: { condition: service_completed_successfully, restart: true }, so the volume is (re)initialized before Wolf starts and on every restart;
- NVIDIA_DRIVER_VOLUME_NAME is derived from ${COMPOSE_PROJECT_NAME}, matching the volume name Compose actually creates.
Troubleshooting pointer — failed preflight checks and initialization errors surface in docker compose logs init-nvidia-driver; deeper troubleshooting is deferred to the existing Nvidia (Manual) tab rather than duplicated.
Warning text on the Nvidia (Container Toolkit) tab updated from "not as stable as the manual method" to "not as stable as the auto or manual method", now that a second recommended path exists.

No existing setup method is changed or removed — this is purely additive.

This depends on the companion PR in the gow repository, which teaches the nvidia-driver image to read the version from a build secret and to initialize the driver volume from its entrypoint: https://github.com/games-on-whales/gow/pull/353

The Compose example documented here builds from https://github.com/games-on-whales/gow.git#master:/images/nvidia-driver/, so this PR should land after games-on-whales/gow#353 — until then the documented configuration builds the pre-change image, which has neither the secret-based version detection nor the entrypoint that populates the volume.

🤖 Generated with Claude Code

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/games-on-whales/wolf/pull/470 **Author:** [@piotrminkina](https://github.com/piotrminkina) **Created:** 8/2/2026 **Status:** 🔄 Open **Base:** `beta` ← **Head:** `feature/nvidia-auto` --- ### 📝 Commits (1) - [`c5209bc`](https://github.com/games-on-whales/wolf/commit/c5209bca0e46bf9455ae11beb112ff04af0f1574) Add Nvidia auto-install instructions to Quickstart guide ### 📊 Changes **1 file changed** (+64 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/modules/user/pages/quickstart.adoc` (+64 -1) </details> ### 📄 Description ## What Adds a third setup method to the Quickstart guide — **Nvidia (Auto)** — documenting a fully automated Nvidia driver setup that removes the two manual steps the existing **Nvidia (Manual)** method requires: looking up the host driver version by hand, and re-creating the driver volume after every host driver upgrade. ## Changes `docs/modules/user/pages/quickstart.adoc`: - **New `Nvidia (Auto)` tab**, placed between `Nvidia (Container Toolkit)` and `Nvidia (Manual)`. It documents a single `docker compose up --detach` workflow: - an `init-nvidia-driver` service builds the `gow/nvidia-driver` image, receiving the host driver version as a Compose secret sourced from `/sys/module/nvidia/version` — so the driver in the volume always matches the running kernel module, with no manual version pinning; - Wolf declares `depends_on: { condition: service_completed_successfully, restart: true }`, so the volume is (re)initialized before Wolf starts and on every restart; - `NVIDIA_DRIVER_VOLUME_NAME` is derived from `${COMPOSE_PROJECT_NAME}`, matching the volume name Compose actually creates. - **Troubleshooting pointer** — failed preflight checks and initialization errors surface in `docker compose logs init-nvidia-driver`; deeper troubleshooting is deferred to the existing `Nvidia (Manual)` tab rather than duplicated. - **Warning text on the `Nvidia (Container Toolkit)` tab** updated from "not as stable as the manual method" to "not as stable as the auto or manual method", now that a second recommended path exists. No existing setup method is changed or removed — this is purely additive. ## Related This depends on the companion PR in the `gow` repository, which teaches the `nvidia-driver` image to read the version from a build secret and to initialize the driver volume from its entrypoint: https://github.com/games-on-whales/gow/pull/353 The Compose example documented here builds from `https://github.com/games-on-whales/gow.git#master:/images/nvidia-driver/`, so **this PR should land after games-on-whales/gow#353** — until then the documented configuration builds the pre-change image, which has neither the secret-based version detection nor the entrypoint that populates the volume. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-10-15 13:00:56 +00:00