CLI reference

jekyo server

Install, inspect, and uninstall JEKYO servers.

Usage

jekyo server [command]

Examples

# See what install would do, without changing anything
jekyo server preflight root@203.0.113.7

# Turn the server into a cluster with TLS and a domain
jekyo server install root@203.0.113.7 --ip 203.0.113.7 \
  --domain example.com --acme-email you@example.com

# Return the machine to clean
jekyo server uninstall

jekyo server harden

Enable fail2ban and automatic security updates on the server.

jekyo server harden [user@host] [flags]

jekyo server info

Show cluster health for the current context.

jekyo server info [flags]

jekyo server install

Turn an Ubuntu server into a JEKYO cluster (idempotent).

jekyo server install <user@host> [flags]
FlagDescription
--acme-email stringLet's Encrypt account email (required with --domain)
--domain stringbase domain (enables TLS certs, registry.<domain>, vpn.<domain>)
--fixauto-remediate fixable preflight warnings
--internal-domain stringcluster-internal DNS suffix (e.g. jekyo.internal); affects only in-cluster/VPN names (default "cluster.local")
--ip stringpublic IP of the server (required)
--k3s-version stringk3s version (default v1.31.5+k3s1)
--name stringcontext name (default: derived from --ip)
--no-gpuskip NVIDIA setup even if a GPU is present
--no-vpnskip the WireGuard VPN addon
--purge-docker-datawith --remove-docker: also delete /var/lib/docker (asks confirmation)
--remove-dockerpurge a detected Docker engine before installing
--storage stringpersisted local volume path (default "/storage")

jekyo server preflight

Check a server without changing anything.

jekyo server preflight <user@host> [flags]
FlagDescription
--storage stringplanned storage path (for the disk-space check) (default "/storage")

jekyo server uninstall

Remove k3s from the server and delete the context.

jekyo server uninstall <context> [flags]
FlagDescription
--purge-storagealso wipe the storage path (asks confirmation)
Previous
All commands