project-nomad/admin/docs/getting-started.md

Getting Started with N.O.M.A.D.

This guide will help you install and set up your N.O.M.A.D. server.

---

Installation

System Requirements

N.O.M.A.D. runs on any Debian-based Linux system (Ubuntu recommended). The installation is terminal-based, and everything is accessed through a web browser — no desktop environment needed.

Recommended Specs:

• AMD Ryzen 7 / Intel Core i7 or better
• 32 GB RAM
• NVIDIA RTX 3060 or AMD equivalent or better (more VRAM = larger AI models)
• 500 GB+ SSD
• Internet connection (for initial install and content downloads)

NOMAD is designed for robust hardware that can run local AI models, store extensive offline libraries, and deliver a full-featured experience. Looking for something more lightweight? Check out Internet in a Box.

Install N.O.M.A.D.

Open a terminal and run these two commands:

curl -fsSL https://raw.githubusercontent.com/Crosstalk-Solutions/project-nomad/refs/heads/master/install/install_nomad.sh -o install_nomad.sh

sudo bash install_nomad.sh

That's it. Once the install finishes, open a browser and go to:

• Same machine: http://localhost:8080
• Other devices on your network: http://YOUR_SERVER_IP:8080

About Internet & Privacy

N.O.M.A.D. is designed for offline use. Internet is only needed:

• During initial installation
• When downloading additional content

There is zero telemetry — your data stays on your device.

About Security

N.O.M.A.D. has no built-in authentication — it's designed to be open and accessible. If you expose it on a network, consider using firewall rules to control which ports are accessible.

---

After Installation

1. Run the Easy Setup Wizard

If this is your first time using N.O.M.A.D., the Easy Setup wizard will help you get everything configured.

Launch Easy Setup →

The wizard walks you through four simple steps:

1. Capabilities — Choose what to enable: Information Library, AI Assistant, Education Platform, Maps, Data Tools, and Notes
2. Maps — Select geographic regions for offline maps
3. Content — Choose curated content collections with Essential, Standard, or Comprehensive tiers
4. Review — Confirm your selections and start downloading

2. Wait for Downloads to Complete

Depending on what you selected, downloads may take a while. You can:

• Monitor progress in the Settings area
• Continue using features that are already installed
• Leave your server running overnight for large downloads

3. Explore Your Content

Once downloads complete, you're ready to go. Your content works offline whenever you need it.

---

Understanding Your Tools

Information Library — Offline Knowledge (Kiwix)

The Information Library stores compressed versions of websites and references that work without internet.

What's included:

• Full Wikipedia (millions of articles)
• Medical references and first aid guides
• How-to guides and survival information
• Classic books from Project Gutenberg

How to use it:

1. Click Information Library from the Command Center home screen or Apps page
2. Choose a collection (like Wikipedia)
3. Search or browse just like the regular website

---

Education Platform — Offline Courses (Kolibri)

The Education Platform provides complete educational courses that work offline.

What's included:

• Khan Academy video courses
• Math, science, reading, and more
• Progress tracking for learners
• Works for all ages

How to use it:

1. Click Education Platform from the Command Center home screen or Apps page
2. Sign in or create a learner account
3. Browse courses and start learning

Tip: Kolibri supports multiple users. Create accounts for each family member to track individual progress.

---

AI Assistant — Built-in Chat

N.O.M.A.D. includes a built-in AI chat interface powered by Ollama. It runs entirely on your server — no internet needed, no data sent anywhere.

What can it do:

• Answer questions on any topic
• Explain complex concepts simply
• Help with writing and editing
• Reference your uploaded documents via the Knowledge Base
• Brainstorm ideas and assist with problem-solving

How to use it:

1. Click AI Chat from the Command Center or go to Chat
2. Type your question or request
3. The AI responds in conversational style

Tip: Be specific in your questions. Instead of "tell me about plants," try "what vegetables grow well in shade?"

Note: The AI Assistant must be installed first. Enable it during Easy Setup or install it from the Apps page.

---

Knowledge Base — Document-Aware AI

The Knowledge Base lets you upload documents so the AI can reference them when answering your questions. It uses semantic search (RAG via Qdrant) to find relevant information from your uploaded files.

Supported file types:

• PDFs, text files, and other document formats
• NOMAD documentation is automatically loaded when the AI Assistant is installed

How to use it:

1. Go to Knowledge Base →
2. Upload your documents (PDFs, text files, etc.)
3. Documents are processed and indexed automatically
4. Ask questions in AI Chat — the AI will reference your uploaded documents when relevant

Use cases:

• Upload emergency plans for quick reference during a crisis
• Load technical manuals and SOPs for offline work sites
• Add curriculum guides for homeschooling
• Store research papers for academic work

---

Maps — Offline Navigation

View maps without internet. Download the regions you need before going offline.

How to use it:

1. Click Maps from the Command Center
2. Navigate by dragging and zooming
3. Search for locations using the search bar

To add more map regions:

1. Go to Settings → Maps Manager
2. Select the regions you need
3. Click Download

Tip: Download maps for areas you travel to frequently, plus neighboring regions just in case.

Open Maps →

---

Managing Your Server

Adding More Content

As your needs change, you can add more content anytime:

• More apps: Settings → Apps
• More references: Settings → Content Explorer or Content Manager
• More map regions: Settings → Maps Manager
• More educational content: Through Kolibri's built-in content browser

Wikipedia Selector

N.O.M.A.D. includes a dedicated Wikipedia content management tool for browsing and downloading Wikipedia packages.

How to use it:

1. Go to Content Explorer →
2. Browse available Wikipedia packages by language and size
3. Select and download the packages you want

System Benchmark

Test your hardware performance and see how your NOMAD build stacks up against the community.

How to use it:

1. Go to System Benchmark →
2. Choose a benchmark type: Full, System Only, or AI Only
3. View your NOMAD Score (a weighted composite of CPU, memory, disk, and AI performance)
4. Create a Builder Tag (your NOMAD-themed identity, like "Tactical-Llama-1234")
5. Share your results with the community leaderboard

Note: Only Full Benchmarks with AI data can be shared to the community leaderboard.

Keeping Things Updated

While you have internet, periodically check for updates:

1. Go to Settings → Check for Updates
2. If updates are available, click to install
3. Wait for the update to complete (your server will restart)

Content updates (Wikipedia, maps, etc.) can be managed separately from software updates.

Monitoring System Health

Check on your server anytime:

1. Go to Settings → System
2. View CPU, memory, and storage usage
3. Check system uptime and status

---

Tips for Best Results

Before Going Offline

• Update everything — Run software and content updates
• Download what you need — Maps, references, educational content
• Test it — Make sure features work while you still have internet to troubleshoot

Storage Management

Your server has limited storage. Prioritize:

• Content you'll actually use
• Critical references (medical, survival)
• Maps for your region
• Educational content matching your needs

Check storage usage in Settings → System.

Getting Help

• In-app docs: You're reading them now
• AI assistant: Ask a question in AI Chat
• Release notes: See what's new in each version

---

Next Steps

You're ready to use N.O.M.A.D. Here are some things to try:

1. Look something up — Search for a topic in the Information Library
2. Learn something — Start a Khan Academy course in the Education Platform
3. Ask a question — Chat with the AI in AI Chat
4. Explore maps — Find your neighborhood in the Maps viewer
5. Upload a document — Add a PDF to the Knowledge Base and ask the AI about it

Enjoy your offline knowledge server!