Team Administration

The Portr client can add a user to a team using the server and secret key in the selected config file.

portr admin users add user@example.com
portr admin users add admin@example.com --team engineering --role admin

--team accepts a team slug. When it is omitted, Portr adds the user to default-team. --role accepts member or admin and defaults to member.

The configured secret key must belong to a team administrator for the target team. A superuser credential can add users to any team.

Password output

When GitHub auto signup is disabled and the email is new, Portr creates an initial password and prints it once:

Added user@example.com to default-team as member.
Password: generated-password

Share the password through a secure channel. It is not returned again.

When GitHub auto signup is enabled, Portr creates new users without a password and omits the password line. Existing users keep their current credentials, so their password is never reset or printed when they are added to another team.

Client template

A team admin can also publish a shared set of tunnels and groups from the admin dashboard, under Client template. Members pick it up with portr auth set on a fresh machine, or portr config pull on an existing one. See Tunnel Templates.

Use another config

Use the global --config flag to select the server and credential:

portr --config ./portr-production.yaml admin users add user@example.com --team engineering