TruthGate Documentation

Before you continue:
If you haven’t set up TruthGate yet, please start with the Setup Guide.
This page assumes you already have TruthGate installed and running.

Getting Started

Once TruthGate is installed, you can access your personal gateway at:

text
https://YOUR_IP

Make sure you’ve changed the default password.
If you prefer, you can also point a domain (IPv4 or IPv6) at your server, but using the raw IP is perfectly fine.

Secure IPFS Access

TruthGate allows you to use your node like a true private, secure gateway:

  • https://YOUR_IP/ipfs/CID
  • https://YOUR_IP/ipns/KEY

These behave just like the public gateways you may be used to — except they’re isolated, hardened, and under your control.

The Web UI

From the top navigation menu, click “Web UI”.
This will open the familiar IPFS Node GUI (the same one from the desktop app), but safely tunneled through TruthGate.

You can:

  • Browse your node
  • Create folders
  • Upload files
  • Pin and manage content

Everything works exactly as you’d expect, with the added security layer of TruthGate.

The Dashboard

Your Dashboard gives you a quick overview of your node:

  • TruthGate + IPFS version
  • Number of peers
  • Repo storage used
  • Bandwidth consumption
  • (and more stats coming soon)

Pin Management

In the navigation bar, you’ll see Pinned then two options:

Pinned CIDs

Manage pinned CIDs quickly and easily.
Add or remove entries with a simple interface.

Pinned IPNS

This page is special, it allows you to pin entire IPNS keys, not just static CIDs.

Features include:

Settings

The Settings dropdown contains two critical pages for managing access and automation.

Users

On the Users page you can add new accounts, manage authentication, and update passwords.
This ensures that only authorized people can access your TruthGate instance.

API

The API page allows you to generate and manage API keys for programmatic access.

  • Main view:
  • Key generation popup:

Once you’ve created an API key, you can call your node like so:

text
https://YOUR_IP/api/v0/YOUR_CALL

You can pass your key in one of two ways:

  • Header:
    X-API-Key: YOUR_KEY
  • Query string:
    ?api_key=YOUR_KEY or ?key=YOUR_KEY
API keys are only shown once. They are stored internally as a secure hash, so they cannot be recovered later.
Save them immediately in a secure, encrypted vault (e.g., KeePass, Bitwarden).

Domains: The Powerhouse

The Domains page is where TruthGate truly shines.

This is the bridge between Web2 and Web3 hosting:

  • Publish websites directly to IPFS
  • Seamlessly bind domains for easy Web2 access
  • Enable hybrid decentralized hosting

If you’re a web developer (or want to host a site with TruthGate), head to:
👉 Site Publishing Guide

Welcome to TruthGate

TruthGate is more than just a secure gateway, it’s part a family of protocols and tools designed to make Web3 mainstream, secure, and usable.

Top-level Pages

Setup
Tgp
No pages yet.

Support "TruthGate"

TruthGate is an open-source project built to make decentralized hosting secure, simple, and actually usable.

Every line of code, every guide, and every improvement is powered by independent work and passion.

If you find TruthGate useful, you can help keep development alive and growing by supporting the project below.


You can also support TruthGate by helping to pin and preserve the following important IPNS addresses:

  • TruthGate Website – The official website for TruthGate.

    k51qzi5uqu5dgo40x3jd83hrm6gnugqvrop5cgixztlnfklko8mm9dihm7yk80

  • IPFS Redirect – A decentralized redirect service used in TruthGate, hosted at ipfs-redirect.unstoppable and ipfsredirect.com.

    k51qzi5uqu5dhbigu9mydyrgfmsbmyokff915scf5hv975z209qad9rhmkgssq

Every gesture, big or small, lets me dedicate more time to making decentralized hosting better. Thank you.