Skip to main content

SSH Keys

SSH keys let Kuploy authenticate to private Git repositories on your behalf (to clone source for builds). You manage them under Settings → SSH Keys.

Add an existing key

  1. Go to Settings → SSH Keys and click Add SSH Key.
  2. Fill in:
    • Name — a label to recognize the key by (e.g. github-deploy).
    • Description — optional note (e.g. "Deploy key for my private repo").
    • Public Key — the ssh-rsa … or ssh-ed25519 … line.
    • Private Key — the full PEM/OpenSSH block, including the -----BEGIN … PRIVATE KEY----- / -----END … PRIVATE KEY----- lines.
  3. Click Create.

Kuploy validates the formats before saving — only RSA and ED25519 keys are accepted. A malformed key is rejected inline ("Invalid public key format" / "Invalid private key format").

Generate a key pair locally

If you don't already have a key, create one with ssh-keygen:

ssh-keygen -t ed25519 -f ./kuploy-key -N "" -C "kuploy"

This writes two files:

  • kuploy-key.pub → paste into Public Key (ssh-ed25519 AAAA… kuploy)
  • kuploy-key → paste into Private Key (-----BEGIN OPENSSH PRIVATE KEY-----…)

For RSA instead: ssh-keygen -t rsa -b 4096 -f ./kuploy-key -N "" -C "kuploy".

Generate a key in-app

The dialog also offers Generate RSA SSH Key and Generate ED25519 SSH Key, which create a fresh pair for you and fill both fields. Use the Public Key / Private Key download buttons to save copies before clicking Create — the private key is shown only once.

Using a key

Once saved, the key is selectable when configuring a Git provider that points at a private repository.