You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update documentation for recent features and hardware page
- Add hardware guide link (projectnomad.us/hardware) to README, FAQ, and About page
- Add Apache 2.0 license section to README and About page
- Add Early Access Channel FAQ and Getting Started mention
- Add GPU passthrough warning troubleshooting entry to FAQ
- Add Knowledge Base document deletion to FAQ and Getting Started
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,6 +82,8 @@ To run LLM's and other included AI tools:
82
82
- OS: Debian-based (Ubuntu recommended)
83
83
- Stable internet connection (required during install only)
84
84
85
+
**For detailed build recommendations at three price points ($200–$800+), see the [Hardware Guide](https://www.projectnomad.us/hardware).**
86
+
85
87
Again, Project N.O.M.A.D. itself is quite lightweight - it's the tools and resources you choose to install with N.O.M.A.D. that will determine the specs required for your unique deployment
86
88
87
89
## About Internet Usage & Privacy
@@ -136,6 +138,10 @@ Use the format `- **Area**: Description` to stay consistent with existing entrie
136
138
-**Discord:**[Join the Community](https://discord.com/invite/crosstalksolutions) - Get help, share your builds, and connect with other NOMAD users
137
139
-**Benchmark Leaderboard:**[benchmark.projectnomad.us](https://benchmark.projectnomad.us) - See how your hardware stacks up against other NOMAD builds
138
140
141
+
## License
142
+
143
+
Project N.O.M.A.D. is licensed under the [Apache License 2.0](LICENSE).
144
+
139
145
## Helper Scripts
140
146
Once installed, Project N.O.M.A.D. has a few helper scripts should you ever need to troubleshoot issues or perform maintenance that can't be done through the Command Center. All of these scripts are found in Project N.O.M.A.D.'s install directory, `/opt/project-nomad`
Copy file name to clipboardExpand all lines: admin/docs/about.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,16 @@
2
2
3
3
Project N.O.M.A.D. (Node for Offline Media, Archives, and Data; "Nomad" for short) is a project started in 2025 by Chris Sherwood of [Crosstalk Solutions, LLC](https://crosstalksolutions.com). The goal of the project is not to create just another utility for storing offline resources, but rather to allow users to run their own ultimate "survival computer".
4
4
5
-
While many similar offline survival computers are designed to be run on bare-minimum, lightweight hardware, Project N.O.M.A.D. is quite the opposite. To install and run the available AI tools, we highly encourage the use of a beefy, GPU-backed device to make the most of your install.
5
+
While many similar offline survival computers are designed to be run on bare-minimum, lightweight hardware, Project N.O.M.A.D. is quite the opposite. To install and run the available AI tools, we highly encourage the use of a beefy, GPU-backed device to make the most of your install. See the [Hardware Guide](https://www.projectnomad.us/hardware) for detailed build recommendations at three price points.
6
6
7
7
Since its initial release, NOMAD has grown to include built-in AI chat with a Knowledge Base for document-aware responses, a System Benchmark with a community leaderboard, curated content collections with tiered options, and an Easy Setup Wizard to get new users up and running quickly.
8
8
9
+
Project N.O.M.A.D. is open source, released under the [Apache License 2.0](https://github.com/Crosstalk-Solutions/project-nomad/blob/main/LICENSE).
- NVIDIA or AMD GPU recommended for faster AI responses
20
20
21
+
**For detailed build recommendations at three price points ($200–$800+), see the [Hardware Guide](https://www.projectnomad.us/hardware).**
22
+
21
23
### How much storage do I need?
22
24
It depends on what you download:
23
25
- Full Wikipedia: ~95GB
@@ -79,13 +81,18 @@ The AI must be installed first — enable it during Easy Setup or install it fro
79
81
3. Documents are processed and indexed automatically
80
82
4. Ask questions in AI Chat — the AI will reference your uploaded documents when relevant
81
83
84
+
You can also remove documents from the Knowledge Base when they're no longer needed.
85
+
82
86
NOMAD documentation is automatically added to the Knowledge Base when the AI Assistant is installed.
83
87
84
88
### What is the System Benchmark?
85
89
The System Benchmark tests your hardware performance and generates a NOMAD Score — a weighted composite of CPU, memory, disk, and AI performance. You can create a Builder Tag (a NOMAD-themed identity like "Tactical-Llama-1234") and share your results with the [community leaderboard](https://benchmark.projectnomad.us).
86
90
87
91
Go to **[System Benchmark →](/settings/benchmark)** to run one.
88
92
93
+
### What is the Early Access Channel?
94
+
The Early Access Channel lets you opt in to receive release candidate builds with the latest features and improvements before they hit stable releases. You can enable or disable it from **Settings → Check for Updates**. Early access builds may contain bugs — if you prefer stability, stay on the stable channel.
95
+
89
96
---
90
97
91
98
## Troubleshooting
@@ -137,6 +144,10 @@ When you add or swap a GPU, N.O.M.A.D. needs to reconfigure the AI container to
137
144
138
145
Force Reinstall recreates the AI container with GPU support enabled. Without this step, the AI continues to run on CPU only.
139
146
147
+
### I see a "GPU passthrough not working" warning
148
+
149
+
N.O.M.A.D. checks whether your GPU is actually accessible inside the AI container. If a GPU is detected on the host but isn't working inside the container, you'll see a warning banner on the System Information and AI Settings pages. Click the **"Fix: Reinstall AI Assistant"** button to recreate the container with proper GPU access. This preserves your downloaded AI models.
150
+
140
151
### AI Chat not available
141
152
142
153
The AI Chat page requires the AI Assistant to be installed first:
Copy file name to clipboardExpand all lines: admin/docs/getting-started.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,6 +103,7 @@ The Knowledge Base lets you upload documents so the AI can reference them when a
103
103
2. Upload your documents (PDFs, text files, etc.)
104
104
3. Documents are processed and indexed automatically
105
105
4. Ask questions in AI Chat — the AI will reference your uploaded documents when relevant
106
+
5. Remove documents you no longer need — they'll be deleted from the index and local storage
106
107
107
108
**Use cases:**
108
109
- Upload emergency plans for quick reference during a crisis
@@ -183,6 +184,8 @@ While you have internet, periodically check for updates:
183
184
184
185
Content updates (Wikipedia, maps, etc.) can be managed separately from software updates.
185
186
187
+
**Early Access Channel:** Want the latest features before they hit stable? Enable the Early Access Channel from the Check for Updates page to receive release candidate builds. You can switch back to stable anytime.
0 commit comments