Use cases, worked through
What people put in a pen, and how to set each one up. Every example assumes you have a pen and your computer is in it (joining). Apps named here are examples of good free ones, not part of Hogman; any app that runs in a browser works.
A family photo site, in five minutes
Goal: the family can browse this year's photos from anywhere; nobody else can.
- Invite each family member from your home page (one invite each). They open the link on their computer and copy the command.
- Put the photos in a folder, then:
$ ./hogman-join share photos ~/Pictures/2026 --background - Tell everyone:
https://photos.yourpen.hogman.
Going further: for albums, uploads and face search, run a photo app such as
Immich or PhotoPrism on an always-on computer and share it from there (share photos 2283).
The app keeps its own accounts; Hogman decides who can reach it at all.
A club or friends' forum
Goal: a private message board for the climbing club, the band, the old school crew, with no ads and nobody reading along.
- Run a forum app on an always-on computer (an old laptop, a mini PC, a small cloud server). Flarum, Discourse and phpBB are common choices.
- On your home page, press Get a share link, then share the forum from that
computer with the link:
$ ./hogman-join share forum 8080 '<server link>' --background - Make a few people admins so they can invite and suspend too (Running your pen).
When someone leaves the club, kick them: every device they have loses access at once, and their names are held so nobody can impersonate them.
A small company's internal tools
Goal: a wiki, dashboards and admin tools that employees reach from anywhere, with nothing exposed to the internet.
- Raise a pen of your own (raising your own pen), so the company holds its own keys.
- Invite each employee. Each one joins their laptop; anyone already using Tailscale for work keeps it, untouched.
- Share each tool from the machine it runs on, each with its own server link from the home
page (a link works once):
share wiki 3000,share grafana 3001,share admin 8080. - Offboarding is one kick: all their devices are cut off in about two seconds.
Internal tools that today sit behind a VPN or an IP allow-list can drop both: they have no public address at all.
A customer portal
Goal: invited customers reach their portal; attackers never even see its login page.
- Invite each customer contact. Make invites from the home page (or script them with
invite createon your own server). - Share the portal from the machine it runs on:
share portal 8080. - When a customer relationship ends, kick that contact.
Hogman isn't audited yet; wait for that before putting anything high-stakes behind it.
Showing work in progress
Goal: let a few people try the site you're building, from your laptop, without deploying it anywhere.
$ npm run dev # listening on 5173, say $ ./hogman-join share demo 5173
Send https://demo.yourpen.hogman to the people in the pen. It has real HTTPS, so
service workers, secure cookies and camera access behave as they will in production. Ctrl-C
takes it down; run it again later and it's back at the same address.
Your home server, from anywhere
Goal: reach the media server, the NAS or Home Assistant at home from your laptop on the road, with HTTPS, and let the family use it too.
- On a computer at home that's in the pen, share the device's local address:
$ ./hogman-join share media http://192.168.1.20:8096 --background - From anywhere, members open
https://media.yourpen.hogman.
Nothing on your home router is opened or forwarded.
Something wrong or unclear on this page? Its source is in site/docs-src; issues and fixes welcome.