HÖGMAN

Running your pen

For the keeper (the pen's owner) and anyone they make an admin. Everything here is on your pen's home page, https://home.yourpen.hogman. If you raised your own pen, each section also shows the command line.

Roles

RoleCan
Owner (the keeper)Everything. Can't be suspended or removed. A pen can have more than one owner, and should: an owner who loses every device needs another owner to invite them back. Owners can demote each other, so make owners only of people you trust completely.
AdminMake and revoke invites, suspend, resume and remove members. Can't act on the owner or other admins.
MemberJoin devices, claim names, run servers and shares. Inviting is keepers-only unless the pen allows members to invite.

Inviting people

Under Invite someone, add a note for yourself ("Alice, from the climbing club") and press Make an invite. You get a link and a QR code. Each invite works for one person, once, and expires after 7 days. Send it however you like: the link is the only way in, so treat it like a key.

Open invites lists the ones nobody has used yet; revoke any of them.

# on your own server
$ hogman-host pen mypen invite create --note "alice"
$ hogman-host pen mypen invite list
$ hogman-host pen mypen invite revoke 3

The herd

The herd lists everyone in the pen with their role, status and number of devices, 20 at a time, with a search box, so it stays quick in a pen of thousands. For each member:

$ hogman-host pen mypen member list
$ hogman-host pen mypen member suspend gary "spamming the forum"
$ hogman-host pen mypen member resume gary
$ hogman-host pen mypen member kick gary "second time"
$ hogman-host pen mypen member role alice admin
$ hogman-host pen mypen member role alice owner

Devices and names

Every member manages their own devices on the home page: Add a device for a one-time join link, and Get a share link to put something in the pen from a computer that isn't in it. Names belong to shares, which name themselves. From the command line:

$ hogman-host pen mypen device list
$ hogman-host pen mypen device key alice personal     # alice's first device only: no account recovery
$ hogman-host pen mypen device rm 12                  # a lost laptop
$ hogman-host pen mypen name list
$ hogman-host pen mypen name release blog

The owner can also claim, reassign or release any name, including held ones.

The audit log

Every invite, join, name change, suspension and removal is recorded with who did it and when:

$ hogman-host pen mypen audit 50

What to tell your members

As keeper you can see who is in the pen, their devices, when they're online and which pen names they look up. You can't see what they send each other, or anything they do outside the pen. Say so when you invite people: who sees what.

Something wrong or unclear on this page? Its source is in site/docs-src; issues and fixes welcome.