[PR #382] [CLOSED] feat: add quickstart scripts for automated Wolf deployment #434

New issue

Closed

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

bsakaguchi commented

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

Owner

📋 Pull Request Information

Original PR: https://github.com/games-on-whales/wolf/pull/382
Author: @JBailes
Created: 4/2/2026
Status: ❌ Closed

Base: stable ← Head: aimee/quickstart-scripts

📝 Commits (6)

c5202e4 feat: add quickstart scripts for automated Wolf deployment
2ea7dfb Update quickstart.adoc
255ddf0 Address PR review: DRY up config, remove defaults duplication, use official Docker install
2d292e9 Specify where and why sudo is required in quickstart docs
c243361 DRY up compose templates, udev rules, start logic, and summary banners
5ec3f2e Merge two NixOS module generators into one with conditional injection

📊 Changes

13 files changed (+2355 additions, -2 deletions)

View changed files

📝 docs/modules/user/pages/quickstart.adoc (+34 -2)
➕ quickstart/README.md (+754 -0)
➕ quickstart/common.sh (+478 -0)
➕ quickstart/configure.sh (+53 -0)
➕ quickstart/docker.sh (+29 -0)
➕ quickstart/incus.sh (+73 -0)
➕ quickstart/lxc.sh (+55 -0)
➕ quickstart/nixos.sh (+247 -0)
➕ quickstart/podman.sh (+141 -0)
➕ quickstart/proxmox.sh (+127 -0)
➕ quickstart/truenas.sh (+163 -0)
➕ quickstart/unraid.sh (+92 -0)
➕ quickstart/wolf.sh (+109 -0)

📄 Description

Summary

Adds the quickstart scripts (from JBailes/wolf) into the official repo under quickstart/
Updates all download URLs in the scripts to point to games-on-whales/wolf (stable branch) instead of JBailes/wolf
Updates quickstart.adoc to prominently feature the automated setup with a clear curl one-liner, while preserving the existing manual Docker/Podman/Proxmox instructions under a "Manual setup" section

The quickstart scripts auto-detect the user's environment (Proxmox, LXC, Incus, Unraid, TrueNAS, NixOS, Docker, or Podman) and handle GPU detection, udev rules, NVIDIA driver volumes, and Wolf + Wolf Den deployment automatically. See the quickstart README for full documentation.

Scripts included

Script	Purpose
`wolf.sh`	Entry point: detects environment, downloads helpers, dispatches
`common.sh`	Shared helpers: GPU detection, compose generation, udev rules, NVIDIA volume
`configure.sh`	Container-side setup (used by Proxmox/LXC/Incus)
`docker.sh`	Docker Compose deployment
`podman.sh`	Podman Quadlet + systemd deployment
`proxmox.sh`	Proxmox LXC creation with GPU passthrough
`lxc.sh`	Standalone LXC container creation
`incus.sh`	Incus container creation
`unraid.sh`	Unraid deployment with boot persistence
`truenas.sh`	TrueNAS SCALE deployment with ZFS + midclt init scripts
`nixos.sh`	NixOS module generation (declarative)

Supersedes #380.

Test plan

Verify curl command in quickstart.adoc downloads wolf.sh correctly from the stable branch once merged
Test wolf.sh on Docker environment
Test wolf.sh on Proxmox environment
Verify quickstart.adoc renders correctly in Antora docs

_{🔄 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/382 **Author:** [@JBailes](https://github.com/JBailes) **Created:** 4/2/2026 **Status:** ❌ Closed **Base:** `stable` ← **Head:** `aimee/quickstart-scripts` --- ### 📝 Commits (6) - [`c5202e4`](https://github.com/games-on-whales/wolf/commit/c5202e4f1cacf77b5e877a365992e3637a85d5e8) feat: add quickstart scripts for automated Wolf deployment - [`2ea7dfb`](https://github.com/games-on-whales/wolf/commit/2ea7dfb7b9d4232293baa57f185252598095a143) Update quickstart.adoc - [`255ddf0`](https://github.com/games-on-whales/wolf/commit/255ddf0081389060b7b5f4c7fd9c7b8b8be0b655) Address PR review: DRY up config, remove defaults duplication, use official Docker install - [`2d292e9`](https://github.com/games-on-whales/wolf/commit/2d292e9e47a943bda92db4dc90ffe7f6eea0fa64) Specify where and why sudo is required in quickstart docs - [`c243361`](https://github.com/games-on-whales/wolf/commit/c243361be994d6185520175042431c5600c349ef) DRY up compose templates, udev rules, start logic, and summary banners - [`5ec3f2e`](https://github.com/games-on-whales/wolf/commit/5ec3f2e3e74ca8e1972b7d8692150c87597517e6) Merge two NixOS module generators into one with conditional injection ### 📊 Changes **13 files changed** (+2355 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `docs/modules/user/pages/quickstart.adoc` (+34 -2) ➕ `quickstart/README.md` (+754 -0) ➕ `quickstart/common.sh` (+478 -0) ➕ `quickstart/configure.sh` (+53 -0) ➕ `quickstart/docker.sh` (+29 -0) ➕ `quickstart/incus.sh` (+73 -0) ➕ `quickstart/lxc.sh` (+55 -0) ➕ `quickstart/nixos.sh` (+247 -0) ➕ `quickstart/podman.sh` (+141 -0) ➕ `quickstart/proxmox.sh` (+127 -0) ➕ `quickstart/truenas.sh` (+163 -0) ➕ `quickstart/unraid.sh` (+92 -0) ➕ `quickstart/wolf.sh` (+109 -0) </details> ### 📄 Description ## Summary - Adds the quickstart scripts (from [JBailes/wolf](https://github.com/JBailes/wolf/tree/main/quickstart)) into the official repo under `quickstart/` - Updates all download URLs in the scripts to point to `games-on-whales/wolf` (stable branch) instead of `JBailes/wolf` - Updates `quickstart.adoc` to prominently feature the automated setup with a clear `curl` one-liner, while preserving the existing manual Docker/Podman/Proxmox instructions under a "Manual setup" section The quickstart scripts auto-detect the user's environment (Proxmox, LXC, Incus, Unraid, TrueNAS, NixOS, Docker, or Podman) and handle GPU detection, udev rules, NVIDIA driver volumes, and Wolf + Wolf Den deployment automatically. See the [quickstart README](https://github.com/games-on-whales/wolf/blob/aimee/quickstart-scripts/quickstart/README.md) for full documentation. ### Scripts included | Script | Purpose | |---|---| | `wolf.sh` | Entry point: detects environment, downloads helpers, dispatches | | `common.sh` | Shared helpers: GPU detection, compose generation, udev rules, NVIDIA volume | | `configure.sh` | Container-side setup (used by Proxmox/LXC/Incus) | | `docker.sh` | Docker Compose deployment | | `podman.sh` | Podman Quadlet + systemd deployment | | `proxmox.sh` | Proxmox LXC creation with GPU passthrough | | `lxc.sh` | Standalone LXC container creation | | `incus.sh` | Incus container creation | | `unraid.sh` | Unraid deployment with boot persistence | | `truenas.sh` | TrueNAS SCALE deployment with ZFS + midclt init scripts | | `nixos.sh` | NixOS module generation (declarative) | Supersedes #380. ## Test plan - [ ] Verify `curl` command in quickstart.adoc downloads `wolf.sh` correctly from the `stable` branch once merged - [ ] Test `wolf.sh` on Docker environment - [ ] Test `wolf.sh` on Proxmox environment - [ ] Verify quickstart.adoc renders correctly in Antora docs --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

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