Files
kestrelos/docs/installation.md
Keli Grubb e61e6bc7e3
All checks were successful
ci/woodpecker/push/push Pipeline was successful
major: kestrel is now a tak server (#6)
## Added

- CoT (Cursor on Target) server on port 8089 enabling ATAK/iTAK device connectivity
- Support for TAK stream protocol and traditional XML CoT messages
- TLS/SSL support with automatic fallback to plain TCP
- Username/password authentication for CoT connections
- Real-time device position tracking with TTL-based expiration (90s default)
- API endpoints: `/api/cot/config`, `/api/cot/server-package`, `/api/cot/truststore`, `/api/me/cot-password`
- TAK Server section in Settings with QR code for iTAK setup
- ATAK password management in Account page for OIDC users
- CoT device markers on map showing real-time positions
- Comprehensive documentation in `docs/` directory
- Environment variables: `COT_PORT`, `COT_TTL_MS`, `COT_REQUIRE_AUTH`, `COT_SSL_CERT`, `COT_SSL_KEY`, `COT_DEBUG`
- Dependencies: `fast-xml-parser`, `jszip`, `qrcode`

## Changed

- Authentication system supports CoT password management for OIDC users
- Database schema includes `cot_password_hash` field
- Test suite refactored to follow functional design principles

## Removed

- Consolidated utility modules: `authConfig.js`, `authSkipPaths.js`, `bootstrap.js`, `poiConstants.js`, `session.js`

## Security

- XML entity expansion protection in CoT parser
- Enhanced input validation and SQL injection prevention
- Authentication timeout to prevent hanging connections

## Breaking Changes

- Port 8089 must be exposed for CoT server. Update firewall rules and Docker/Kubernetes configurations.

## Migration Notes

- OIDC users must set ATAK password via Account settings before connecting
- Docker: expose port 8089 (`-p 8089:8089`)
- Kubernetes: update Helm values to expose port 8089

Co-authored-by: Madison Grubb <madison@elastiflow.com>
Reviewed-on: #6
2026-02-17 16:41:41 +00:00

1.4 KiB

Installation

Run KestrelOS from source (npm), Docker, or Kubernetes (Helm).

npm (from source)

git clone <repository-url> kestrelos
cd kestrelos
npm install
npm run dev

Open http://localhost:3000. First run creates data/kestrelos.db and bootstraps an admin (see Authentication).

Production:

npm run build
npm run preview
# or
node .output/server/index.mjs

Set HOST=0.0.0.0 and PORT for production.

Docker

docker build -t kestrelos:latest .
docker run -p 3000:3000 -p 8089:8089 \
  -v kestrelos-data:/app/data \
  kestrelos:latest

Expose ports 3000 (web/API) and 8089 (CoT for ATAK/iTAK).

Helm (Kubernetes)

From registry:

helm repo add keligrubb --username USER --password TOKEN \
  https://git.keligrubb.com/api/packages/keligrubb/helm
helm install kestrelos keligrubb/kestrelos

From source:

helm install kestrelos ./helm/kestrelos

Configure in helm/kestrelos/values.yaml. Health: GET /health, /health/live, /health/ready.

Environment Variables

Variable Default Description
HOST Nuxt default Bind address (use 0.0.0.0 for all interfaces)
PORT 3000 Web/API port
DB_PATH data/kestrelos.db SQLite database path

See Authentication for auth variables. See ATAK and iTAK for CoT options.