Supports updating and upgrading site.
SYNOPSIS
ee site update [<site-name>] [--ssl[=<ssl>]] [--wildcard] [--ssl-key=<ssl-key-path>] [--ssl-crt=<ssl-crt-path>] [--php=<php-version>] [--proxy-cache=<on-or-off>] [--proxy-cache-max-size=<size-in-m-or-g>] [--proxy-cache-max-time=<time-in-s-or-m>] [--proxy-cache-key-zone-size=<size-in-m>] [--add-alias-domains=<comma-seprated-domains-to-add>] [--delete-alias-domains=<comma-seprated-domains-to-delete>]
OPTIONS
[<site-name>]
: Name of the site. If omitted, EasyEngine uses the site whose folder you’re in.
[--ssl[=<ssl>]]
: Update ssl on site. le (the default when --ssl has no value), self, inherit, custom, or off to remove SSL. Switching between normal and wildcard certificates isn’t supported; turn SSL off first.
Options:
- le
- self
- inherit
- custom
- off
[--wildcard]
: Enable wildcard SSL on site. Only for sites created with --wildcard or --mu=subdom; needs DNS-01 validation.
[--ssl-key=<ssl-key-path>]
: Path to the SSL key file. Required with --ssl=custom.
[--ssl-crt=<ssl-crt-path>]
: Path to the SSL crt file. Required with --ssl=custom.
[--php=<php-version>]
: PHP version for site. Currently only supports PHP 5.6, 7.0, 7.2, 7.3, 7.4, 8.0, 8.1, 8.2, 8.3, 8.4, and 8.5. latest isn’t accepted here. EasyEngine backs up the current PHP config to .backup/config/php-<old-version> in the site directory before switching.
Options:
- 5.6
- 7.0
- 7.2
- 7.3
- 7.4
- 8.0
- 8.1
- 8.2
- 8.3
- 8.4
- 8.5
[--proxy-cache=<on-or-off>]
: Enable or disable proxy cache on site.
Options:
- on
- off
[--proxy-cache-max-size=<size-in-m-or-g>]
: Max size for proxy-cache.
[--proxy-cache-max-time=<time-in-s-or-m>]
: Max time for proxy cache to last.
[--proxy-cache-key-zone-size=<size-in-m>]
: Size of proxy cache key zone.
[--add-alias-domains=<comma-seprated-domains-to-add>]
: Comma separated list of domains to add to site’s alias domains.
[--delete-alias-domains=<comma-seprated-domains-to-delete>]
: Comma separated list of domains to delete from site’s alias domains.
EXAMPLES
# Add SSL to non-ssl site
$ ee site update example.com --ssl=le
# Add wildcard SSL to a non-ssl site that was created with --wildcard or --mu=subdom (needs DNS-01 validation)
$ ee site update example.com --ssl=le --wildcard
# Add self-signed SSL to non-ssl site
$ ee site update example.com --ssl=self
# Add custom SSL to non-ssl site
$ ee site update example.com --ssl=custom --ssl-key=/path/to/site.key --ssl-crt=/path/to/site.crt
# Update PHP version of site.
$ ee site update example.com --php=8.4
# Update proxy cache of site.
$ ee site update example.com --proxy-cache=on
# Update proxy cache of site.
$ ee site update example.com --proxy-cache=on --proxy-cache-max-size=1g --proxy-cache-max-time=30s
# Add alias domains to a WordPress subdom site.
$ ee site update example.com --add-alias-domains='a.com,*.a.com,b.com,c.com'
# Delete alias domains from a WordPress subdom site.
$ ee site update example.com --delete-alias-domains='a.com,*.a.com,b.com'
SUBCOMMANDS
| Name | Description |
|---|---|
| ee site clean | Clears Object and Page cache for site. |
| ee site clone | Clones a website from source to a new website in destination. |
| ee site create | Runs site installation with provided site type. |
| ee site delete | Deletes a website. |
| ee site disable | Disables a website. It will stop and remove the docker containers of the website if they are running. |
| ee site enable | Enables a website. It will start the docker containers of the website if they are stopped. |
| ee site info | Display all the relevant site information, credentials and useful links. |
| ee site list | Lists the created websites. |
| ee site publish | Publishes site online using ngrok. |
| ee site refresh | Re-create sites docker-compose file and update the containers. |
| ee site reload | Reload services in containers without restarting container(s) associated with site. |
| ee site restart | Restarts containers associated with site. |
| ee site share | Share a site online using ngrok. |
| ee site ssl | Verifies ssl challenge and also renews certificates(if expired). |
| ee site ssl-renew | Renews letsencrypt ssl certificates. |
| ee site ssl-verify | Completes or retries Let’s Encrypt certificate issuance for a site. |
| ee site sync | Syncs a website from source to an existing website in destination. |
GLOBAL PARAMETERS
--sites_path=<path>
Absolute path to where all sites will be stored.
--locale=<locale>
Locale for WordPress.
--le-mail=<le-mail>
Mail-id to be used for letsencrypt.
--env=<env>
EasyEngine server environment.
--wp-mail=<wp-mail>
Default Mail-id to be used for WordPress site installation.
--sysctl=<true/false>
Whether to add sysctl config in docker-compose.
--skip-tty=<true/false>
Skip tty allocation for remote command execution.
--custom-compose=<custom-compose file>
Path to custom compose file.
--[no-]color
Whether to colorize the output.
--debug[=<group>]
Show all PHP errors; add verbosity to EE bootstrap.
--quiet
Suppress informational messages.