keligrubb/kestrelos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 11 Wiki Activity

simplify docs
Some checks failed
ci/woodpecker/pr/pr Pipeline failed
Details

Browse Source
This commit is contained in:
Madison Grubb
2026-02-17 11:25:40 -05:00
parent 82bd51c3a4
commit c696f38f4d
6 changed files with 181 additions and 570 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/README.md
View File

@@ -1,20 +1,11 @@
# KestrelOS documentation
# KestrelOS Documentation
KestrelOS is a Tactical Operations Center (TOC) for OSINT feeds: map view, cameras/devices, live sharing, and ATAK/iTAK integration.
Tactical Operations Center (TOC) for OSINT feeds: map view, cameras/devices, live sharing, and ATAK/iTAK integration.
## Documentation index
## Quick Start
| Topic | Description |
|-------|-------------|
| [Installation](installation.md) | Install via npm, Docker, or Helm (Kubernetes) |
| [Authentication](auth.md) | Local login, OIDC config, and sign up |
| [Map and cameras](map-and-cameras.md) | Using the map, adding and viewing cameras (IPTV, ALPR, CCTV, NVR, etc.) |
| [ATAK and iTAK](atak-itak.md) | Connect ATAK (Android) and iTAK (iOS) to KestrelOS as a TAK Server |
| [Share live](live-streaming.md) | Add your mobile device as a live camera (WebRTC) |
## Quick links
- **First run**: [Installation](installation.md) → [Authentication](auth.md) (bootstrap admin or OIDC).
- **Add a camera**: [Map and cameras](map-and-cameras.md) (API or future UI).
- **Stream from phone**: [Share live](live-streaming.md) (HTTPS required).
- **Use ATAK/iTAK**: [ATAK and iTAK](atak-itak.md) (Server connection, port 8089 for CoT).
1. [Installation](installation.md) — npm, Docker, or Helm
2. [Authentication](auth.md) — First login (bootstrap admin or OIDC)
3. [Map and cameras](map-and-cameras.md) — Add devices and view streams
4. [ATAK and iTAK](atak-itak.md) — Connect TAK clients (port 8089)
5. [Share live](live-streaming.md) — Stream from mobile device (HTTPS required)