Setup guide

Installing GuardDex — what to have ready

GuardDex installs with one command on your own Linux box. The installer asks a short series of questions — this page walks through every one of them so you can have your details (DNS, NextDNS, a couple of API keys) ready before you start. Most are optional and can be added later.

1. Before you start

You'll need:

2. Run the installer

Download your GuardDex package from Richey Business, then from inside it run:

# from the unpacked GuardDex folder
sudo bash install.sh

A friendly blue setup screen guides you through the questions below. It then installs everything and starts GuardDex automatically.

3. The questions it'll ask

Have these handy. Anything marked optional can be left blank now and added later in Settings → Integrations.

QuestionWhat it is / where to get it
Server name required A friendly name for this node, e.g. "Home GuardDex". Just a label.
Public URL required How your devices reach this box. On a home network that's usually http://192.168.1.x:8088 (the box's local IP). If you have a domain, use that.
Admin email required Your login for the GuardDex dashboard. Use an email you check.
Admin password & PIN required A strong password (12+ characters) for the dashboard, plus a short PIN that protects the Settings page.
Anthropic API key optional Powers the AI scam explanations and the "Ask my Guardian" helper. Get one at console.anthropic.com → API Keys. (Without it, GuardDex falls back to its built‑in rules.)
ntfy URL · username · password optional For free push notifications to your phone. Use the public ntfy.sh or your own ntfy server. Leave blank to skip push.
HaveIBeenPwned API key optional Powers the Breach Monitor (checks if your family's emails appear in data breaches). Key from haveibeenpwned.com/API/Key (a few dollars/month).
VirusTotal API key optional Adds link/file reputation to scans. Free key at virustotal.com → your profile → API Key.
NextDNS Profile ID optional Connects GuardDex to your NextDNS filtering. The Profile ID is the short code shown on your NextDNS Setup tab (e.g. a1b2c3).
NextDNS API key optional Lets GuardDex read your DNS logs and auto‑block bad domains. Find it in NextDNS under Account → API.
🌐 About your DNS: GuardDex protects best when your devices' DNS points at a filtering resolver. Two easy paths: use NextDNS (cloud, the keys above) or run our self‑hosted DNS Fortress on the same box. Either way, you then set your router's (or phone's) DNS to that resolver — GuardDex watches it, explains what's blocked, and alerts you.
💡 Don't have all the keys yet? No problem — press Enter to skip any optional one. Everything can be pasted in later from the dashboard's Settings → Integrations page, and GuardDex works out of the box without them.

4. After it finishes

⬇ Get the app & package
Stuck or want us to set it up for you? Email [email protected] — real people who answer.