Skip to the content
Documentation

exp:expstatickeys

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

Make or show the SSH deploy key of a static publishing target: ed25519, the private half in the secret store, the public half to add to the repository

Usage

./console exp:expstatickeys [options]
php bin/php/expstatickeys.php [options]
./console exp:static:keys [options]

Aliases

exp:static:keys

Help

The output of ./console help exp:expstatickeys (the script run with --help), without the standard options:

Usage: bin/php/expstatickeys.php [OPTION]... [TARGET]
The SSH deploy key of a static publishing target
With --generate it makes a key pair for the target (ed25519, with ssh-keygen), stores the private half
in the secret store (Setup > Secrets, never in a file of the site) and prints the public half: add it
to the repository as a deploy key with write access, set the target's Credential=sshkey:<secret> and
its Remote to the SSH address ([email protected]:owner/repo.git). Without --generate it shows the public
half and the fingerprint of the key the target has.

./console exp:static:keys github-public --generate
./console exp:static:keys github-public
./console exp:static:keys github-public --generate --replace       a new key; the old one stops working


Options:
  --generate      Make a new deploy key (ed25519) and store its private half in the secret store
  --replace       With --generate: replace the target's deploy key (the old one stops working)
  --format=VALUE  text (default) or json (the machine output exp-static/1)

Options

Option Value Description
--generate - Make a new deploy key (ed25519) and store its private half in the secret store
--replace - With --generate: replace the target's deploy key (the old one stops working)
--format required text (default) or json (the machine output exp-static/1)

Arguments

[target]

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/expstatickeys.php, kernel/private/classes/commands/expstatickeys.php

See also

Generated example: exp:expstatickeys

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.