ee site create --type=html
Runs the standard HTML site installation.
SYNOPSIS
ee site create <site-name> [--ssl=<ssl>] [--ssl-key=<ssl-key-path>] [--ssl-crt=<ssl-crt-path>] [--wildcard] [--type=<type>] [--alias-domains=<domains>] [--skip-status-check] [--public-dir=<dir>]
OPTIONS
<site-name>
: Name of website.
[--ssl=<ssl>]
: Enables ssl on site. le (Let’s Encrypt), self (self-signed), inherit (the parent site’s wildcard certificate) or custom (your own key and certificate, with --ssl-key and --ssl-crt). --ssl without a value means le.
Options:
- le
- self
- inherit
- custom
[--ssl-key=<ssl-key-path>]
: Path to the SSL key file.
[--ssl-crt=<ssl-crt-path>]
: Path to the SSL crt file.
[--wildcard]
: Gets wildcard SSL. Let’s Encrypt issues wildcard certificates only over DNS-01: with cloudflare-api-key set, EasyEngine adds the TXT records itself; otherwise it prints them, and you finish with ee site ssl-verify.
[--type=<type>]
: Type of the site to be created. Values: html,php,wp etc.
[--alias-domains=<domains>]
: Comma separated list of alias domains for the site.
[--skip-status-check]
: Skips site status check.
[--public-dir=<dir>]
: Set custom source directory for site inside htdocs.
EXAMPLES
# Create html site
$ ee site create example.com
# Create html site with ssl from letsencrypt
$ ee site create example.com --ssl=le
# Create html site with wildcard ssl
$ ee site create example.com --ssl=le --wildcard
# Create html site with self signed certificate
$ ee site create example.com --ssl=self
# Create html site with custom source directory inside htdocs ( SITE_ROOT/app/htdocs/src )
$ ee site create example.com --public-dir=src
# Create site with alias domains and ssl
$ ee site create example.com --type=html --alias-domains='a.com,*.a.com,b.com' --ssl=le
ee site create --type=php
Runs the standard PHP Site installation.
SYNOPSIS
ee site create <site-name> --type=php [--cache] [--admin-email=<admin-email>] [--with-db] [--local-db] [--php=<php-version>] [--alias-domains=<domains>] [--dbname=<dbname>] [--dbuser=<dbuser>] [--dbpass=<dbpass>] [--dbhost=<dbhost>] [--with-local-redis] [--skip-check] [--skip-status-check] [--ssl=<ssl>] [--ssl-key=<ssl-key-path>] [--ssl-crt=<ssl-crt-path>] [--wildcard] [--force] [--public-dir=<dir>]
OPTIONS
<site-name>
: Name of website.
[--cache]
: Use redis cache for PHP.
[--admin-email=<admin-email>]
: E-Mail of the administrator.
[--with-db]
: Create database for php site.
[--local-db]
: Create separate db container instead of using global db.
[--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, 8.5 and latest. latest is an alias for the default version (8.4), not the newest one; pass --php=8.5 for PHP 8.5.
Default: 8.4
Options:
- 5.6
- 7.0
- 7.2
- 7.3
- 7.4
- 8.0
- 8.1
- 8.2
- 8.3
- 8.4
- 8.5
- latest
[--alias-domains=<domains>]
: Comma separated list of alias domains for the site.
[--dbname=<dbname>]
: Set the database name.
[--dbuser=<dbuser>]
: Set the database user.
[--dbpass=<dbpass>]
: Set the database password.
[--dbhost=<dbhost>]
: Set the database host. Pass value only when remote dbhost is required, as host or host:port reachable from the site’s containers (not localhost). Requires --dbuser and --dbpass.
[--with-local-redis]
: Enable cache with local redis container.
[--skip-check]
: If set, the database connection is not checked.
[--skip-status-check]
: Skips site status check.
[--ssl=<ssl>]
: Enables ssl on site. le (Let’s Encrypt), self (self-signed), inherit (the parent site’s wildcard certificate) or custom (your own key and certificate, with --ssl-key and --ssl-crt). --ssl without a value means le.
Options:
- le
- self
- inherit
- custom
[--ssl-key=<ssl-key-path>]
: Path to the SSL key file.
[--ssl-crt=<ssl-crt-path>]
: Path to the SSL crt file.
[--wildcard]
: Gets wildcard SSL. Let’s Encrypt issues wildcard certificates only over DNS-01: with cloudflare-api-key set, EasyEngine adds the TXT records itself; otherwise it prints them, and you finish with ee site ssl-verify.
[--force]
: Resets the remote database if it is not empty.
[--public-dir=<dir>]
: Set custom source directory for site inside htdocs.
EXAMPLES
# Create php site (without db)
$ ee site create example.com --type=php
# Create php site with db
$ ee site create example.com --type=php --with-db
# Create php site with ssl from letsencrypt
$ ee site create example.com --type=php --ssl=le
# Create php site with wildcard ssl
$ ee site create example.com --type=php --ssl=le --wildcard
# Create site with alias domains and ssl
$ ee site create example.com --type=php --alias-domains='a.com,*.a.com,b.com' --ssl=le
# Create php site with self signed certificate
$ ee site create example.com --type=php --ssl=self
# Create php site with remote database (host[:port], reachable from the site's containers)
$ ee site create example.com --type=php --with-db --dbhost=db.example.com:3306 --dbuser=username --dbpass=password
# Create php site with custom source directory inside htdocs ( SITE_ROOT/app/htdocs/public )
$ ee site create example.com --type=php --public-dir=public
# Create PHP site with custom ssl certs
$ ee site create example.com --type=php --ssl=custom --ssl-key='/path/to/example.com.key' --ssl-crt='/path/to/example.com.crt'
ee site create --type=wp
Runs the standard WordPress Site installation.
SYNOPSIS
ee site create <site-name> --type=wp [--cache] [--vip] [--mu=<subdir|subdom>] [--alias-domains=<domains>] [--title=<title>] [--admin-user=<admin-user>] [--admin-email=<admin-email>] [--admin-pass=<admin-pass>] [--allow-insecure-pass] [--local-db] [--with-local-redis] [--public-dir=<dir>] [--php=<php-version>] [--dbname=<dbname>] [--dbuser=<dbuser>] [--dbpass=<dbpass>] [--dbhost=<dbhost>] [--dbprefix=<dbprefix>] [--dbcharset=<dbcharset>] [--dbcollate=<dbcollate>] [--skip-check] [--version=<version>] [--skip-content] [--skip-install] [--skip-status-check] [--ssl=<ssl>] [--ssl-key=<ssl-key-path>] [--ssl-crt=<ssl-crt-path>] [--wildcard] [--proxy-cache=<on-or-off>] [--proxy-cache-max-size=<size-in-m-or-g>] [--proxy-cache-max-time=<time-in-s-or-m>] [--yes] [--force]
OPTIONS
<site-name>
: Name of website.
[--cache]
: Use redis cache for WordPress.
[--vip]
: Create WordPress VIP GO site using your vip repo which contains wp-content dir. Default it will use skeleton repo. Pass your repo as --vip=<git-url>. Needs git on the server.
Default: https://github.com/Automattic/vip-go-skeleton.git
[--mu=<subdir|subdom>]
: Specify WordPress Multi-site type. subdom also serves *.example.com and needs a wildcard certificate when SSL is on.
[--alias-domains=<domains>]
: Comma separated list of alias domains for the site.
[--title=<title>]
: Title of your site.
[--admin-user=<admin-user>]
: Username of the administrator.
[--admin-email=<admin-email>]
: E-Mail of the administrator.
[--admin-pass=<admin-pass>]
: Password for the administrator. At least 8 characters, with at least one letter and one number. Default: a random password (see ee site info).
[--allow-insecure-pass]
: Allow insecure password for the administrator. Skips the password check above.
[--local-db]
: Create separate db container instead of using global db.
[--with-local-redis]
: Enable cache with local redis container.
[--public-dir=<dir>]
: Set custom source directory for site inside htdocs.
[--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, 8.5 and latest. latest is an alias for the default version (8.4), not the newest one; pass --php=8.5 for PHP 8.5.
Default: 8.4
Options:
- 5.6
- 7.0
- 7.2
- 7.3
- 7.4
- 8.0
- 8.1
- 8.2
- 8.3
- 8.4
- 8.5
- latest
[--dbname=<dbname>]
: Set the database name.
[--dbuser=<dbuser>]
: Set the database user.
[--dbpass=<dbpass>]
: Set the database password.
[--dbhost=<dbhost>]
: Set the database host. Pass value only when remote dbhost is required, as host or host:port reachable from the site’s containers (not localhost). Requires --dbuser and --dbpass.
[--dbprefix=<dbprefix>]
: Set the database table prefix.
[--dbcharset=<dbcharset>]
: Set the database charset.
Default: utf8mb4
[--dbcollate=<dbcollate>]
: Set the database collation.
[--skip-check]
: If set, the database connection is not checked.
[--version=<version>]
: Select which WordPress version you want to download. Accepts a version number, latest or nightly.
[--skip-content]
: Download WP without the default themes and plugins.
[--skip-install]
: Skips wp-core install.
[--skip-status-check]
: Skips site status check.
[--ssl=<ssl>]
: Enables ssl on site. le (Let’s Encrypt), self (self-signed), inherit (the parent site’s wildcard certificate) or custom (your own key and certificate, with --ssl-key and --ssl-crt). --ssl without a value means le.
Options:
- le
- self
- inherit
- custom
[--ssl-key=<ssl-key-path>]
: Path to the SSL key file.
[--ssl-crt=<ssl-crt-path>]
: Path to the SSL crt file.
[--wildcard]
: Gets wildcard SSL. Let’s Encrypt issues wildcard certificates only over DNS-01: with cloudflare-api-key set, EasyEngine adds the TXT records itself; otherwise it prints them, and you finish with ee site ssl-verify.
[--proxy-cache=<on-or-off>]
: Enable or disable proxy cache on site. on also enables the Redis cache.
Default: off
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.
[--yes]
: Do not prompt for confirmation.
[--force]
: Resets the remote database if it is not empty.
EXAMPLES
# Create WordPress site
$ ee site create example.com --type=wp
# Create WordPress multisite subdir site
$ ee site create example.com --type=wp --mu=subdir
# Create WordPress multisite subdom site
$ ee site create example.com --type=wp --mu=subdom
# Create WordPress site with ssl from letsencrypt
$ ee site create example.com --type=wp --ssl=le
# Create WordPress site with wildcard ssl
$ ee site create example.com --type=wp --ssl=le --wildcard
# Create WordPress site with self signed certificate
$ ee site create example.com --type=wp --ssl=self
# Create WordPress site with remote database (host[:port], reachable from the site's containers)
$ ee site create example.com --type=wp --dbhost=db.example.com:3306 --dbuser=username --dbpass=password
# Create WordPress site with custom site title, locale, admin user, admin email and admin password
$ ee site create example.com --type=wp --title="My Site" --locale=nl_NL --admin-email=admin@example.com --admin-user=siteadmin --admin-pass='Ch4nge-me-now'
# Create WordPress site with custom source directory inside htdocs ( SITE_ROOT/app/htdocs/current )
$ ee site create example.com --type=wp --public-dir=current
# Create WordPress site with custom ssl certs
$ ee site create example.com --type=wp --ssl=custom --ssl-key='/path/to/example.com.key' --ssl-crt='/path/to/example.com.crt'
# Create WordPress site with redis cache
$ ee site create example.com --type=wp --cache
# Create WordPress site with PHP 8.5
$ ee site create example.com --type=wp --php=8.5
# Create subdomain MU WordPress site with alias domains and ssl (needs DNS-01 validation for the wildcard certificate)
$ ee site create example.com --type=wp --mu=subdom --alias-domains='a.com,*.a.com,b.com' --ssl=le
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 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. |
| ee site update | Supports updating and upgrading site. |
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.