README

EasyEngine WordPress 网站创建类型包。

快速链接： 使用 | 贡献 | 支持

使用

本包实现了以下命令

ee site create --type=wp

运行标准 WordPress 网站安装。

ee site create --type=wp <site-name> [--cache] [--vip] [--mu=<subdir>] [--mu=<subdom>] [--title=<title>] [--admin-user=<admin-user>] [--admin-pass=<admin-pass>] [--admin-email=<admin-email>] [--local-db] [--with-local-redis] [--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=<value>] [--wildcard] [--yes] [--force]

选项

<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>]
	WordPress sub-dir Multi-site.

[--mu=<subdom>]
	WordPress sub-domain Multi-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.

[--php=<php-version>]
	PHP version for site. Currently only supports PHP 5.6 and latest.
	---
	default: latest
	options:
		- 5.6
		- 7.2
		- 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=<value>]
	Enables ssl on site.

[--wildcard]
	Gets wildcard SSL .

[--yes]
	Do not prompt for confirmation.

[--force]
	Resets the remote database if it is not empty.

示例

# 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 --admin-email=easyengine@example.com --admin-user=easyengine --admin-pass=easyengine

ee site delete

删除一个网站。

ee site delete <site-name> [--yes]

选项

<site-name>
	Name of website to be deleted.

[--yes]
	Do not prompt for confirmation.

示例

# Delete site
$ ee site delete example.com

ee site update

支持更新和升级网站。

ee site update [<site-name>] [--ssl=<ssl>] [--wildcard]

[<site-name>]
	Name of the site.

[--ssl=<ssl>]
	Enable ssl on site

[--wildcard]
	Enable wildcard SSL on site.

示例

# Add SSL to non-ssl site
$ ee site update example.com --ssl=le

# Add SSL to non-ssl site
$ ee site update example.com --ssl=le --wildcard

# Add self-signed SSL to non-ssl site
$ ee site update example.com --ssl=self

ee site info --type=wp

运行标准 WordPress 网站安装。

ee site info --type=wp <site-name> [--cache] [--vip] [--mu=<subdir>] [--mu=<subdom>] [--title=<title>] [--admin-user=<admin-user>] [--admin-pass=<admin-pass>] [--admin-email=<admin-email>] [--local-db] [--with-local-redis] [--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=<value>] [--wildcard] [--yes] [--force]

选项

<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>]
	WordPress sub-dir Multi-site.

[--mu=<subdom>]
	WordPress sub-domain Multi-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.

[--php=<php-version>]
	PHP version for site. Currently only supports PHP 5.6 and latest.
	---
	default: latest
	options:
		- 5.6
		- 7.2
		- 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=<value>]
	Enables ssl on site.

[--wildcard]
	Gets wildcard SSL .

[--yes]
	Do not prompt for confirmation.

[--force]
	Resets the remote database if it is not empty.

示例

# 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 --admin-email=easyengine@example.com --admin-user=easyengine --admin-pass=easyengine

ee site enable

启用一个网站。如果网站容器已停止，它将启动网站容器。

ee site enable [<site-name>] [--force] [--verify]

选项

[<site-name>]
	Name of website to be enabled.

[--force]
	Force execution of site enable.

[--verify]
	Verify if required global services are working.

示例

# Enable site
$ ee site enable example.com

# Enable site with verification of dependent global services. (Note: This takes longer time to enable the
site.)
$ ee site enable example.com --verify

# Force enable a site.
$ ee site enable example.com --force

ee site disable

禁用一个网站。如果网站容器正在运行，它将停止并删除网站容器。

ee site disable [<site-name>]

选项

[<site-name>]
	Name of website to be disabled.

示例

# Disable site
$ ee site disable example.com

ee site info

显示所有相关网站信息、凭据和有用的链接。

ee site info [<site-name>]

[<site-name>]
	Name of the website whose info is required.

示例

# Display site info
$ ee site info example.com

ee site ssl

验证 SSL 挑战并（如果已过期）更新证书。

ee site ssl <site-name> [--force]

选项

<site-name>
	Name of website.

[--force]
	Force renewal.

ee site list

列出创建的网站。

ee site list [--enabled] [--disabled] [--format=<format>]

抽象列表

[--enabled]
	List only enabled sites.

[--disabled]
	List only disabled sites.

[--format=<format>]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - yaml
	  - json
	  - count
	  - text
	---

示例

# List all sites
$ ee site list

# List enabled sites
$ ee site list --enabled

# List disabled sites
$ ee site list --disabled

# List all sites in JSON
$ ee site list --format=json

# Count all sites
$ ee site list --format=count

ee site reload --type=wp

运行标准 WordPress 网站安装。

ee site reload --type=wp <site-name> [--cache] [--vip] [--mu=<subdir>] [--mu=<subdom>] [--title=<title>] [--admin-user=<admin-user>] [--admin-pass=<admin-pass>] [--admin-email=<admin-email>] [--local-db] [--with-local-redis] [--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=<value>] [--wildcard] [--yes] [--force]

选项

<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>]
	WordPress sub-dir Multi-site.

[--mu=<subdom>]
	WordPress sub-domain Multi-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.

[--php=<php-version>]
	PHP version for site. Currently only supports PHP 5.6 and latest.
	---
	default: latest
	options:
		- 5.6
		- 7.2
		- 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=<value>]
	Enables ssl on site.

[--wildcard]
	Gets wildcard SSL .

[--yes]
	Do not prompt for confirmation.

[--force]
	Resets the remote database if it is not empty.

示例

# 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 --admin-email=easyengine@example.com --admin-user=easyengine --admin-pass=easyengine

ee site restart --type=wp

运行标准 WordPress 网站安装。

ee site restart --type=wp <site-name> [--cache] [--vip] [--mu=<subdir>] [--mu=<subdom>] [--title=<title>] [--admin-user=<admin-user>] [--admin-pass=<admin-pass>] [--admin-email=<admin-email>] [--local-db] [--with-local-redis] [--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=<value>] [--wildcard] [--yes] [--force]

选项

<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>]
	WordPress sub-dir Multi-site.

[--mu=<subdom>]
	WordPress sub-domain Multi-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.

[--php=<php-version>]
	PHP version for site. Currently only supports PHP 5.6 and latest.
	---
	default: latest
	options:
		- 5.6
		- 7.2
		- 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=<value>]
	Enables ssl on site.

[--wildcard]
	Gets wildcard SSL .

[--yes]
	Do not prompt for confirmation.

[--force]
	Resets the remote database if it is not empty.

示例

# 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 --admin-email=easyengine@example.com --admin-user=easyengine --admin-pass=easyengine

ee site share

使用 ngrok 在线分享网站。

ee site share <site-name> [--disable] [--refresh] [--token=<token>]

选项

<site-name>
	Name of website.

[--disable]
	Take online link down.

[--refresh]
	Refresh site share if link has expired.

[--token=<token>]
	ngrok token.

示例

# Share a site online
$ ee site share example.com

# Refresh shareed link if expired
$ ee site share example.com --refresh

# Disable online link
$ ee site share example.com --disable

ee site clean

清除网站的 Object 和 Page 缓存。

ee site clean [<site-name>] [--page] [--object]

选项

[<site-name>]
	Name of website to be enabled.

[--page]
	Clear page cache.

[--object]
	Clear object cache.

示例

# Clear Both cache type for site.
$ ee site clean example.com

# Clear Object cache for site.
$ ee site clean example.com --object

# Clear Page cache for site.
$ ee site clean example.com --page

贡献

我们感谢您主动为这个项目做出贡献。

贡献不仅限于代码。我们鼓励您以最适合您能力的方式做出贡献，例如编写教程、在当地聚会中演示、帮助其他用户解决支持问题或修订我们的文档。

报告一个错误

你认为你发现了一个错误？我们很乐意你帮助我们将其修复。

在创建新的问题之前，你应该 搜索现有问题，看看是否有现有的解决方案，或者它是否已经在更新的版本中修复。

一旦你进行了一些搜索，发现你的错误没有开放或已修复的问题，请 创建一个新的问题。尽可能提供详细信息，如果可能，提供清晰的复现步骤。

创建一个 pull request

想要贡献一个新功能？请首先 创建一个新的问题，讨论该功能是否适合项目。

支持

Github 问题不是用于一般支持问题的地方，但你可以尝试其他途径： https://easyengine.io/support/

此 README.md 是通过使用 ee scaffold package-readme (doc) 从项目的代码库动态生成的。要提出更改建议，请提交针对代码库相应部分的 pull request。