Skip to content

Latest commit

 

History

19 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IOWAP Documentation

Setup guides, concepts, API reference, and node documentation for the IOWAP ecosystem.


Structure

├── concepts.md              # Core concepts — capabilities, tasks, relay model
├── getting-started.md       # First steps — set up a server, register a node
├── server/                  # Relay server documentation
│   ├── setup.md             #   Server installation & configuration
│   ├── docker.md            #   Docker deployment
│   ├── dashboard.md         #   Dashboard usage guide
│   └── admin.md             #   Administration & user management
├── node/                    # Node framework documentation
│   ├── setup.md             #   Node installation & registration
│   ├── ha-node.md           #   Home Assistant node (HAOS app + integration)
│   ├── cli-reference.md     #   Full CLI reference
│   ├── node-config.md       #   node.yaml configuration
│   ├── node-daemon.md       #   Daemon operation & service management
│   ├── capabilities.md      #   Capability definition reference
│   ├── capability-concept.md#   Capability matching model
│   ├── concept.md           #   Node architecture deep-dive
│   ├── ssn.md               #   SSN proxy & capability pages
│   ├── federation.md        #   Federation (peer-to-peer relay bridging)
│   └── token-lifecycle.md   #   Token auth flow
├── storage/                 # Storage node documentation
│   ├── qnap-storage-node.md #   QNAP-specific deployment
│   └── storage.md           #   Storage capabilities & bridge mode
└── reference/               # Reference documentation
    ├── api.md               #   Full API reference
    ├── database-backends.md #   SQLite & PostgreSQL backends
    └── design-board.md      #   Architecture decisions & design history

About

This repo contains all documentation for the IOWAP ecosystem — everything you need to set up a relay server, run a node, or build your own capabilities.

Area Code Repo
Relay Server iowap-org/iowap-server
Node Framework iowap-org/iowap-node
Storage Node iowap-org/iowap-storage
Meta iowap-org/iowap

License

AGPL-3.0

About

IOWAP documentation — setup, concepts, API reference, node guides

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors