github-mirror/project-nomad
1
0
Fork 0
mirror of https://github.com/Crosstalk-Solutions/project-nomad.git synced 2026-03-28 03:29:25 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Replace placeholder content with comprehensive documentation

Browse Source 
- Replace Lorem Ipsum home.md with proper welcome page
- Add getting-started.md: New user onboarding guide
- Add faq.md: FAQ and troubleshooting for offline use
- Add use-cases.md: Use case examples (emergency prep, homeschool, etc.)

Documentation written with non-technical users in mind, focusing on
clarity and self-sufficiency when offline.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Chris Sherwood 2026-01-18 15:04:21 -08:00 committed by Jake Turner
parent ab909e8ef8
commit adecb66fa8
4 changed files with 596 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
admin/docs/faq.md Normal file
View File

@ -0,0 +1,168 @@
# Frequently Asked Questions
## General Questions
### What is N.O.M.A.D.?
N.O.M.A.D. (Node for Offline Media, Archives, and Data) is a personal server that gives you access to knowledge, education, and AI assistance without requiring an internet connection. It runs on your own hardware, keeping your data private and accessible anytime.
### Do I need internet to use N.O.M.A.D.?
No — that's the whole point. Once your content is downloaded, everything works offline. You only need internet to:
- Download new content
- Update the software
- Sync the latest versions of Wikipedia, maps, etc.
### What hardware do I need?
N.O.M.A.D. is designed for capable hardware, especially if you want to use the AI features. Recommended:
- Modern multi-core CPU
- 16GB+ RAM (32GB+ for best AI performance)
- SSD storage (size depends on content — 500GB minimum, 2TB+ recommended)
- GPU recommended for faster AI responses
### How much storage do I need?
It depends on what you download:
- Full Wikipedia: ~95GB
- Khan Academy courses: ~50GB
- Medical references: ~500MB
- US state maps: ~2-3GB each
- AI models: 10-40GB depending on model
Start with essentials and add more as needed.
---
## Content Questions
### How do I add more Wikipedia content?
1. Go to **Settings** (hamburger menu → Settings)
2. Click **ZIM Manager**
3. Browse available content
4. Click Download on items you want
### How do I add more educational courses?
1. Open **Kolibri**
2. Sign in as an admin
3. Go to **Device → Channels**
4. Browse and import available channels
### How current is the content?
Content is as current as when it was last downloaded. Wikipedia snapshots are typically updated monthly. Check the file names or descriptions for dates.
### Can I add my own files?
Currently, N.O.M.A.D. uses standard content formats (ZIM files for Kiwix, Kolibri channels for education). Custom content support may be added in future versions.
---
## Troubleshooting
### A feature isn't loading or shows a blank page
**Try these steps:**
1. Wait 30 seconds — some features take time to start
2. Refresh the page (Ctrl+R or Cmd+R)
3. Go back to the Command Center and try again
4. Check Settings → System to see if the service is running
5. Try restarting the service (Stop, then Start in Apps manager)
### Maps show a gray/blank area
The Maps feature requires downloaded map data. If you see a blank area:
1. Go to **Settings → Maps Manager**
2. Download map regions for your area
3. Wait for downloads to complete
4. Return to Maps and refresh
### AI responses are slow
Local AI requires significant computing power. To improve speed:
- Close other applications on the server
- Ensure adequate cooling (overheating causes throttling)
- Consider using a smaller/faster AI model if available
- Add a GPU if your hardware supports it
### "Service unavailable" or connection errors
The service might still be starting up. Wait 1-2 minutes and try again.
If the problem persists:
1. Go to **Settings → Apps**
2. Find the problematic service
3. Click **Restart**
4. Wait 30 seconds, then try again
### Downloads are stuck or failing
1. Check your internet connection
2. Go to **Settings** and check available storage
3. If storage is full, delete unused content
4. Cancel the stuck download and try again
### The server won't start
If you can't access the Command Center at all:
1. Verify the server hardware is powered on
2. Check network connectivity
3. Try accessing directly via the server's IP address
4. Check server logs if you have console access
### I forgot my Kolibri password
Kolibri passwords are managed separately:
1. If you're an admin, you can reset user passwords in Kolibri's user management
2. If you forgot the admin password, you may need to reset it via command line (contact your administrator)
---
## Updates and Maintenance
### How do I update N.O.M.A.D.?
1. Go to **Settings → Check for Updates**
2. If an update is available, click to install
3. The system will download updates and restart automatically
4. This typically takes 2-5 minutes
### Should I update regularly?
Yes, while you have internet access. Updates include:
- Bug fixes
- New features
- Security improvements
- Performance enhancements
### How do I update content (Wikipedia, etc.)?
Content updates are separate from software updates:
1. Go to **Settings → ZIM Manager**
2. Check for newer versions of your installed content
3. Download updated versions as needed
Tip: New Wikipedia snapshots are released approximately monthly.
### What happens if an update fails?
The system is designed to recover gracefully. If an update fails:
1. The previous version should continue working
2. Try the update again later
3. Check Settings → System for error messages
---
## Privacy and Security
### Is my data private?
Yes. N.O.M.A.D. runs entirely on your hardware. Your searches, AI conversations, and usage data never leave your server.
### Can others access my server?
By default, N.O.M.A.D. is accessible on your local network. Anyone on the same network can access it. For public networks, consider additional security measures.
### Does the AI send data anywhere?
No. The AI runs completely locally. Your conversations are not sent to any external service.
---
## Getting More Help
### The AI can help
Try asking Open WebUI for help. The local AI can answer questions about many topics, including technical troubleshooting.
### Check the documentation
You're in the docs now. Use the menu to find specific topics.
### Release Notes
See what's changed in each version: **[Release Notes](/docs/release-notes)**

185
admin/docs/getting-started.md Normal file
View File

@ -0,0 +1,185 @@
# Getting Started with N.O.M.A.D.
This guide will help you set up your N.O.M.A.D. server and start using it effectively.
## First Steps
### 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:
- Choose which apps to enable
- Download map regions for your area
- Select knowledge collections (Wikipedia, medical references, etc.)
**[Launch Easy Setup →](/easy-setup)**
The wizard walks you through four simple steps:
1. **Apps** — Choose additional tools like CyberChef or FlatNotes
2. **Maps** — Select geographic regions for offline maps
3. **ZIM Files** — Choose reference collections (Wikipedia, medical, survival guides)
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
### Kiwix — Your Offline Library
Kiwix 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 **Kiwix** from the Command Center
2. Choose a collection (like Wikipedia)
3. Search or browse just like the regular website
**[Open Kiwix →](/kiwix)**
---
### Kolibri — Offline Education
Kolibri 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 **Kolibri** from the Command Center
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.
**[Open Kolibri →](/kolibri)**
---
### Open WebUI — Your AI Assistant
Chat with a local AI that runs entirely on your server — no internet needed.
**What can it do:**
- Answer questions on any topic
- Explain complex concepts simply
- Help with writing and editing
- Brainstorm ideas
- Assist with problem-solving
**How to use it:**
1. Click **Open WebUI** from the Command Center
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?"
**[Open AI Chat →](/openwebui)**
---
### 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 →](/maps)**
---
## Managing Your Server
### Adding More Content
As your needs change, you can add more content anytime:
- **More apps:** Settings → Apps
- **More references:** Settings → ZIM Manager
- **More map regions:** Settings → Maps Manager
- **More educational content:** Through Kolibri's built-in content browser
### 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 Open WebUI for help with almost anything
- **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 Kiwix
2. **Learn something** — Start a Khan Academy course in Kolibri
3. **Ask a question** — Chat with the AI in Open WebUI
4. **Explore maps** — Find your neighborhood in the Maps viewer
Enjoy your offline knowledge server!

110
admin/docs/home.md
View File

@ -1,71 +1,67 @@
# Lorem Ipsum Markdown Showcase
# Welcome to Project N.O.M.A.D.
Your personal offline knowledge server is ready to use.
## What is N.O.M.A.D.?
**N.O.M.A.D.** stands for **Node for Offline Media, Archives, and Data**. It's your personal server for accessing knowledge, education, and AI assistance — even when you have no internet connection.
Think of it as having Wikipedia, Khan Academy, an AI assistant, and offline maps all in one place, running on hardware you control.
## What Can You Do?
### Browse Offline Knowledge
Access millions of Wikipedia articles, medical references, how-to guides, and ebooks — all stored locally on your server. No internet required.
**[Open Kiwix →](/kiwix)**
### Learn Something New
Khan Academy courses covering math, science, economics, and more. Complete with videos and exercises, all available offline.
**[Open Kolibri →](/kolibri)**
### Chat with AI
Ask questions, get explanations, brainstorm ideas, or get help with writing. Your local AI assistant works completely offline.
**[Open AI Chat →](/openwebui)**
### View Offline Maps
Navigate and explore maps without an internet connection. Download regions you need before going offline.
**[Open Maps →](/maps)**
---
## Introduction
## Getting Started
This document serves as a comprehensive example of **Markdown's various formatting possibilities**, using the classic *Lorem Ipsum* text as its content. From basic text styling to lists, code blocks, and tables, you'll find a demonstration of common Markdown features here.
**New to N.O.M.A.D.?** Use the Easy Setup wizard to configure your server and download content collections.
**[Run Easy Setup →](/easy-setup)**
Or explore the **[Getting Started Guide](/docs/getting-started)** for a walkthrough of all features.
---
## Basic Text Formatting
## Quick Links
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
* This text is **bold**.
* This text is *italic*.
* This text is ***bold and italic***.
* This text is ~~struck through~~.
* You can also use `backticks` for `inline code`.
| I want to... | Go here |
|--------------|---------|
| Download more content | [Install Apps](/apps) |
| Add Wikipedia/reference content | [ZIM Manager](/settings/zim-manager) |
| Download map regions | [Maps Manager](/settings/maps-manager) |
| Check for updates | [System Update](/settings/updates) |
| View system status | [Settings](/settings) |
---
## Headers
## Keeping Your Server Updated
Markdown supports up to six levels of headers.
N.O.M.A.D. works best when kept up to date while you have internet access. This ensures you have the latest:
- Software features and bug fixes
- Wikipedia and reference content
- Educational materials
- AI model improvements
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
When you go offline, you'll have everything you need — the last synced versions of all your content.
---
## Lists
### Unordered List
* Lorem ipsum dolor sit amet.
* Consectetur adipiscing elit.
* Sed do eiusmod tempor.
* Incididunt ut labore et dolore magna.
* Aliqua ut enim ad minim veniam.
### Ordered List
1. Quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
2. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
3. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
---
## Blockquotes
> "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
>
> — John Doe, *Lorem Ipsum Anthology*
---
## Code Blocks
```python
def fibonacci(n):
a, b = 0, 1
for i in range(n):
print(a, end=" ")
a, b = b, a + b
fibonacci(10)
**[Check for Updates →](/settings/updates)**

190
admin/docs/use-cases.md Normal file
View File

@ -0,0 +1,190 @@
# What Can You Do With N.O.M.A.D.?
N.O.M.A.D. is designed to be your information lifeline when internet isn't available. Here's how different people use it.
---
## Emergency Preparedness
When disasters strike, internet and cell service often go down first. N.O.M.A.D. keeps critical information at your fingertips.
**What you can do:**
- Look up first aid and emergency medical procedures
- Access survival guides and emergency protocols
- Find information about water purification, food storage, shelter building
- Use offline maps to navigate when GPS services are degraded
- Research plant identification, weather patterns, radio frequencies
**Recommended content:**
- Medical Library ZIM collection
- Survival/Prepper reference guides
- Maps for your region and evacuation routes
- Wikipedia (searchable for almost any topic)
---
## Homeschooling and Education
Teach your children anywhere, with or without internet. Complete curriculum available offline.
**What you can do:**
- Access Khan Academy's full course library (math, science, reading, history)
- Track progress for multiple students
- Supplement with Wikipedia for research projects
- Use the AI as a patient tutor for any subject
- Access classic literature through Project Gutenberg
**Recommended content:**
- Khan Academy courses via Kolibri
- Wikipedia for Schools (curated for younger learners)
- Project Gutenberg (classic books)
- Educational ZIM collections
**Tip:** Create separate Kolibri accounts for each child to track their individual progress.
---
## Off-Grid Living
Living away from reliable internet doesn't mean living without information.
**What you can do:**
- Research DIY projects and repairs
- Look up gardening, animal husbandry, food preservation
- Access medical references for remote healthcare
- Learn new skills through educational videos
- Get AI help with planning and problem-solving
**Recommended content:**
- How-to and DIY reference collections
- Medical and first aid guides
- Agricultural and homesteading references
- Maps for your rural area
- Practical skills courses in Kolibri
---
## Remote Work Sites
Construction sites, research stations, ships, and remote facilities often lack reliable internet.
**What you can do:**
- Access technical references and documentation
- Use AI for writing assistance and analysis
- Look up regulations, standards, and procedures
- Provide educational resources for workers
- Maintain communication records with note-taking apps
**Recommended content:**
- Industry-specific technical references
- Relevant Wikipedia categories
- Maps of work areas
- Documentation and compliance guides
---
## Travel and Expeditions
International travel, cruises, camping trips — stay informed anywhere.
**What you can do:**
- Access maps without expensive roaming data
- Research destinations, history, and culture
- Translate concepts with AI assistance
- Identify plants, animals, and geological features
- Access travel health information
**Recommended content:**
- Maps for destination countries/regions
- Wikipedia in relevant languages
- Medical/health references
- Cultural and historical content
---
## Privacy-Conscious Users
Some people simply prefer to keep their searches and questions private.
**What you can do:**
- Search Wikipedia without being tracked
- Ask AI questions that stay on your own hardware
- Learn about sensitive topics privately
- Keep your intellectual curiosity to yourself
**How it works:**
- All data stays on your server
- No search history sent to companies
- No AI conversations leave your network
- You control your own information
---
## Medical Reference
When you can't reach a doctor, having reliable medical information can be critical.
**What you can access:**
- NHS Medicines A-Z (drug information and interactions)
- Medical Library (field medicine, emergency procedures)
- First aid guides
- Anatomy and physiology references
- Disease and symptom information
**Important:** Medical references are for information only. They don't replace professional medical care. In emergencies, always seek professional help when possible.
**Recommended content:**
- Medical Essentials ZIM collection
- NHS Medicines reference
- First aid and emergency medicine guides
---
## Academic Research
Students and researchers can work without depending on university networks.
**What you can do:**
- Access Wikipedia's extensive article database
- Use AI for research assistance and summarization
- Work on papers and projects offline
- Cross-reference multiple sources
- Take notes with built-in tools
**Recommended content:**
- Full Wikipedia
- Academic and educational references
- Subject-specific ZIM collections
- Note-taking apps (FlatNotes)
---
## Setting Up for Your Use Case
### Step 1: Identify Your Needs
What situations might you face without internet? What information would you need?
### Step 2: Prioritize Content
Storage is limited. Focus on:
1. Critical safety information (medical, emergency)
2. Content matching your primary use case
3. General reference (Wikipedia)
4. Nice-to-have additions
### Step 3: Download While You Can
Keep your server updated while you have internet. You never know when you'll need to go offline.
### Step 4: Practice
Try using N.O.M.A.D. before you need it. Familiarity with the tools makes them more useful in a crisis.
---
## Need Something Specific?
N.O.M.A.D. content is customizable. If you don't see what you need:
1. **Check ZIM Remote Explorer** — Thousands of ZIM files are available
2. **Browse Kolibri channels** — Educational content for many subjects
3. **Request features** — Let us know what content would help you
Your offline server, your content choices.