+-------------------------------------------------------------------------------
| Running ${PKGSTEM} on OpenBSD
+-------------------------------------------------------------------------------

Official documentation
======================

See the Teleport documentation at https://goteleport.com/docs/

A quick introduction to Teleport Community Edition is available at:

  https://goteleport.com/docs/get-started/deploy-community/

Keep in mind that the OpenBSD port of ${PKGSTEM} currently lacks
the following features:

- Web UI
- multi-factor authentication (FIDO2)
- Windows Remote Desktop Protocol

Usage
=====

The following programs are installed by the ${PKGSTEM} package.

Read the official documentation and run the built-in 'help' command
of each tool for further information.

teleport
--------

The main Teleport binary that runs the Auth Service, Proxy Service,
and Teleport Agent services.

The Teleport server should be run with the _teleport user account.

The server might print a message which claims that it requires root
access because it uses "/var/lib/teleport", which is false.
There is nothing Teleport does which requires root access to the
operating system.

Another message might suggest to run "sudo teleport start".
Use "rcctl enable teleport && rcctl start teleport" instead.

tctl
----

tctl is the administrative command-line interface for managing a
Teleport cluster. It allows administrators to configure roles,
manage users, and work with resources such as tokens, trusted
clusters, and audit logs.

tsh
---

tsh is the command-line tool used by Teleport users to authenticate,
connect to infrastructure resources, and manage active sessions.
It supports SSH, Kubernetes, databases, and applications.
