ee site create -–type=html
Runs the standard HTML site installation.
OPTIONS
<site-name>
: Name of website.
[--ssl]
: Enables ssl on site.
---
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 .
[--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]
: 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.
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 and latest.
---
default: latest
options:
- 5.6
- 7.0
- 7.2
- 7.3
- 7.4
- 8.0
- 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.
[--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]
: Enables ssl on site.
---
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 .
[--force]
: Resets the remote database if it is not empty.
[--public-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=html --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
$ ee site create example.com --type=php --with-db --dbhost=localhost --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 --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.
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.
---
default: https://github.com/Automattic/vip-go-skeleton.git
---
[--mu=<subdir|subdom>]
: Specify WordPress Multi-site type.
[--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-pass=<admin-pass>]
: Password for the the administrator.
[--admin-email=<admin-email>]
: E-Mail of the administrator.
[--local-db]
: Create separate db container instead of using global db.
[--with-local-redis]
: Enable cache with local redis container.
[--public-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 and latest.
---
default: latest
options:
- 5.6
- 7.0
- 7.2
- 7.3
- 7.4
- 8.0
- 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.
[--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]
: Enables ssl on site.
---
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.
[--proxy-cache=<on-or-off>]
: Enable or disable proxy cache on site.
---
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
$ ee site create example.com --type=wp --dbhost=localhost --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=easyengine --locale=nl_NL [email protected] --admin-user=easyengine --admin-pass=easyengine
# 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 --ssl=custom --ssl-key='/path/to/example.com.key' --ssl-crt='/path/to/example.com.crt'
# Create subodm MU WordPress site with alias domains and ssl
$ 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 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 | Verifies ssl challenge and also renews certificates(if expired). |
ee site sync | Syncs a website from source to an existing website in destination. |
ee site update | Supports updating and upgrading site. |
GLOBAL PARAMETERS
Argument | Description |
---|---|
--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. |
--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. |
--[no-]color | Whether to colorize the output. |
--debug[=<group>] | Show all PHP errors; add verbosity to EE bootstrap. |
--quiet | Suppress informational messages. |