Configuration examples

Paths in YAML resolve relative to the configuration file. These are the templates shipped with the project; complete the setup guide before starting a daemon.

Client configuration

# Install as ~/.config/psh/config.yaml. Paths are relative to this file.
version: 1
identity: id_psh_hybrid.pem
known_hosts: known_hosts
hosts:
  lab:
    hostname: lab.example.net
    user: alice
    port: 2222
  alternate:
    hostname: other.example.net
    user: alice
    identity: alternate_psh_hybrid.pem

Download client.yaml

Server configuration

# Install as /etc/psh/pshd.yaml, owned by root and not group/world writable.
# Before starting pshd, replace alice with an existing non-root account and
# install its psh paired SPKI PEM public identity as authorized/alice.pub.pem.
# Generate the host key explicitly (as root):
#   psh keygen -f /etc/psh/host_psh_hybrid.pem --no-passphrase
# pshd uses raw public keys, not X.509 certificates, and never generates keys.
version: 1
listen:
  - '0.0.0.0:2222'
  - '[::]:2222'
host_key: host_psh_hybrid.pem
users:
  alice:
    authorized_keys:
      - authorized/alice.pub.pem

Download server.yaml

Full schema reference

See psh_config(5) for all fields, validation rules, and defaults. Server configuration and authorization files must be root-owned and not group/world writable. Keep directories administrator-controlled.