Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.47 KB

File metadata and controls

66 lines (45 loc) · 2.47 KB

TruthGate documentation

TruthGate is a self-hosted edge gateway, management plane, and static-site publishing system for Kubo/IPFS.

This documentation is organized by task:

I want to… Start here
Install a production node Setup
Sign in for the first time First run
Publish a static website Site publishing
Understand the architecture Concepts
Integrate through APIs API documentation
Implement or inspect TGP TGP protocol
Develop TruthGate Developer guide
Look up exact defaults Reference
Diagnose a problem Troubleshooting

TruthGate dashboard

Documentation principles

The repository documentation describes behavior that exists in the current codebase.

  • Planned behavior is labeled planned.
  • Security mechanisms are described concretely rather than as guarantees.
  • TGP is documented as an operational protocol, not legal immunity.
  • Production instructions are Docker-first.
  • Every documentation directory has an index.md.
  • Exact values belong in reference pages so explanatory pages do not duplicate them.

Core product areas

Management and access

TruthGate provides account login, role-based users, session authentication, API-key management, and an authenticated path to the native IPFS WebUI.

IPFS operations

TruthGate manages CID pins, watched IPNS names, current-target repinning, Kubo configuration, storage policy, repository migration, content providing, and node diagnostics.

Publishing

Static output can be published to IPFS, associated with IPNS/TGP metadata, and served through mapped domains with automatic TLS and SPA-aware routing.

Protocols and APIs

TruthGate exposes selected authenticated Kubo operations, public domain metadata, and the TruthGate Pointer protocol.

Recommended reading order

For an operator:

  1. Docker installation
  2. First run
  3. Networking
  4. Storage and backups
  5. Site publishing

For a developer:

  1. Architecture
  2. Request routing
  3. Developer guide
  4. API index
  5. TGP specification