TruthGate Documentation
Drop a star on GitHub to show some love (or to submit a ticket / discussion)
Join the Discord server
Follow me on Twitter/X
Support TruthGate by pinning the IPNS key or the latest CID:
IPNS Peer ID:
loading…CIDv0:
loading…These values are fetched live from TruthGate’s API endpoints for this site (latest at the time of load). Learn how to use this feature yourself in the Site Publishing Docs .
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:
https://YOUR_IPMake 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/CIDhttps://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:
- Automatic re-pinning of updated IPNS entries
- Full support for the TruthGate Pointer Protocol
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:
https://YOUR_IP/api/v0/YOUR_CALLYou can pass your key in one of two ways:
- Header:
X-API-Key: YOUR_KEY - Query string:
?api_key=YOUR_KEYor?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
This project is built and maintained by a solo developer. If this project has helped you, saved you time, or just made your day a little easier and you're feeling generous. you can visit the support page to help keep it going. Thank you, truly, for even considering it.
