Documentation

Finding your way

The docs follow the app. Get started comes first, then a section for each part of Settings in the same order, and Reference comes last. Each section opens with a one-screen overview that lists its pages.

Each page starts with a one-sentence summary. A list of its sections stays beside the page on a wide screen, and folds into a single row under the summary on a phone. An address names the section, the page and the heading, for example /docs/terminal/multiplexer/#how-switching-works.

You can also search from the app. Press Cmd+K on a Mac, or Ctrl+K on Windows and Linux, and type the name of a section, a page or one of its headings. Enter opens it in the Docs view on the canvas.

Sections

• Get startedThe shortest way from a server with Infraternal on it to a terminal that keeps running when you close the tab.
• TerminalEvery terminal is a session that keeps running on its machine, and you arrange sessions as windows on the canvas.
• MachinesA machine is a computer that runs the infraternal agent, the program that lets Infraternal open terminals on it.
• MeshThe mesh is a private network that joins your machines.
• AccessAccess decides who may reach what: which machine may connect to which, and which person may sign in as which account.
• YouYour account is a passkey, recovery words for when you lose it, and the browsers, devices and tools signed in as you.
• SharingSharing makes a service on one of your machines reachable from outside the mesh, under a name of your own and over HTTPS.
• AppearanceAppearance changes how Infraternal looks on this device: the colour theme, the font, the size of text and controls, and the size new windows start at.
• ReferenceTables to look things up in, rather than guides to read from top to bottom.