Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions content/open-location-hub/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
---
title: "Software Documentation"
description: "Use the documents in this directory for software behavior, runtime configuration, and integration guidance."
description: "Reference documentation for hub architecture, configuration, authentication, and RPC behavior."
draft: false
generated: true
generated_from: "docs/index.md"
github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/index.md"
---
_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._

Use the documents in this directory for software behavior, runtime configuration, and integration guidance.

- `architecture.md`: system structure, processing flows, and trust boundaries
- `configuration.md`: environment variables and runtime tuning
- `auth.md`: JWT auth modes, authorization model, and permission file behavior
- `rpc.md`: REST-facing RPC usage and control-plane behavior
Reference documentation for hub architecture, configuration, authentication, and RPC behavior.
4 changes: 1 addition & 3 deletions content/open-location-hub/docs/architecture.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
title: "Architecture"
description: "Generated documentation page for Architecture."
description: "System structure, processing flows, and trust boundaries."
draft: false
generated: true
generated_from: "docs/architecture.md"
github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/architecture.md"
---
_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._

## Layers
- `cmd/hub`: process bootstrap and wiring
- `internal/config`: environment-driven configuration
Expand Down
2 changes: 0 additions & 2 deletions content/open-location-hub/docs/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ generated: true
generated_from: "docs/auth.md"
github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/auth.md"
---
_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._

This project supports standards-based JWT bearer authentication for the REST API and an authorization model built around JWT claims plus a server-side permissions file.

The same token verifier is also used for the OMLOX WebSocket surface, but WebSocket authentication happens per message through `params.token` instead of the HTTP `Authorization` header.
Expand Down
2 changes: 0 additions & 2 deletions content/open-location-hub/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ generated: true
generated_from: "docs/configuration.md"
github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/configuration.md"
---
_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._

All runtime configuration is environment-driven.

Runtime lifecycle behavior:
Expand Down
2 changes: 0 additions & 2 deletions content/open-location-hub/docs/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ generated: true
generated_from: "docs/rpc.md"
github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/docs/rpc.md"
---
_This page is generated from the Open Location Hub source documentation and should not be edited in the website repository._

## What RPC is

RPC is the hub's command and diagnostics interface.
Expand Down
Loading