Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:expstatickeys

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.

Download as PDF

Address: https://doc.exponential.earth/learninminutes/exphelp/viewer/examples/commands/expstatickeys.md

On this page

exp:expstatickeys

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.

Script bin/php/expstatickeys.php, code in kernel/private/classes/commands/expstatickeys.php. Run it from the installation root, as the user the web server runs as:

./console exp:expstatickeys --help
./console exp:static:keys --help
php bin/php/expstatickeys.php --help

Help text

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

OptionValueHelp
--generateMake a new deploy key (ed25519) and store its private half in the secret store
--replaceWith --generate: replace the target's deploy key (the old one stops working)
--formatrequiredtext (default) or json (the machine output exp-static/1)

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).

Arguments: [target].


Generated by ./console exp:help:examples from bin/php/expstatickeys.php, kernel/private/classes/commands/expstatickeys.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x