Houseguest™ documentation

Give a named person time-limited, email-verified access to an app on your private network, on its real hostnames or a Houseguest address.

Start here

Admins

Connect an agent inside your network, verify a domain, invite the people who share. Getting started for admins

Sharers

Open a preview, invite viewers or give standing access, watch who used it, end it. Getting started for sharers

Viewers

What an invited person sees: a link, a 6-digit code from their inbox, then the app. What viewers see

Security

What the agent, the edge and Houseguest can and cannot do, and what is kept. Security model

Install an agentDocker, Docker Compose or a systemd service. Outbound on 443 only.

Previews and standing accessInvites for a few people, or a list that comes back.

Domains and addressesThe app's own hostnames, or a Houseguest address with no DNS changes.

TCP and SSHSSH in a browser terminal, or any TCP service through the command line.

Members and rolesOwners, admins, members, custom roles, scoped grants.

TroubleshootingWhat each message means and what to do about it.