easyengine/site-command
, (*1)
Quick links: Using | Contributing | Support, (*2)
Using
This package implements the following commands:, (*3)
ee site create --type=html
Runs the standard HTML site installation., (*4)
ee site create --type=html <site-name> [--ssl=<value>] [--wildcard] [--type=<type>] [--skip-status-check]
OPTIONS, (*5)
<site-name>
Name of website.
[--ssl=<value>]
Enables ssl via letsencrypt certificate.
[--wildcard]
Gets wildcard SSL .
[--type=<type>]
Type of the site to be created. Values: html,php,wp etc.
[--skip-status-check]
Skips site status check.
EXAMPLES, (*6)
# 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
ee site delete
Deletes a website., (*7)
ee site delete <site-name> [--yes]
OPTIONS, (*8)
<site-name>
Name of website to be deleted.
[--yes]
Do not prompt for confirmation.
EXAMPLES, (*9)
# Delete site
$ ee site delete example.com
ee site update
Supports updating and upgrading site., (*10)
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.
EXAMPLES, (*11)
# 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 create --type=html
Runs the standard HTML site installation., (*12)
ee site create --type=html <site-name> [--ssl=<value>] [--wildcard] [--type=<type>] [--skip-status-check]
OPTIONS, (*13)
<site-name>
Name of website.
[--ssl=<value>]
Enables ssl via letsencrypt certificate.
[--wildcard]
Gets wildcard SSL .
[--type=<type>]
Type of the site to be created. Values: html,php,wp etc.
[--skip-status-check]
Skips site status check.
EXAMPLES, (*14)
# 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
ee site enable
Enables a website. It will start the docker containers of the website if they are stopped., (*15)
ee site enable [<site-name>] [--force] [--verify]
OPTIONS, (*16)
[<site-name>]
Name of website to be enabled.
[--force]
Force execution of site enable.
[--verify]
Verify if required global services are working.
EXAMPLES, (*17)
# 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
Disables a website. It will stop and remove the docker containers of the website if they are running., (*18)
ee site disable [<site-name>]
OPTIONS, (*19)
[<site-name>]
Name of website to be disabled.
EXAMPLES, (*20)
# Disable site
$ ee site disable example.com
ee site ssl
Verifies ssl challenge and also renews certificates(if expired)., (*21)
ee site ssl <site-name> [--force]
OPTIONS, (*22)
<site-name>
Name of website.
[--force]
Force renewal.
ee site info
Display all the relevant site information, credentials and useful links., (*23)
ee site info [<site-name>]
[<site-name>]
Name of the website whose info is required.
EXAMPLES, (*24)
# Display site info
$ ee site info example.com
ee site list
Lists the created websites., (*25)
ee site list [--enabled] [--disabled] [--format=<format>]
abstract list, (*26)
[--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
---
EXAMPLES, (*27)
# 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=html
Runs the standard HTML site installation., (*28)
ee site reload --type=html <site-name> [--ssl=<value>] [--wildcard] [--type=<type>] [--skip-status-check]
OPTIONS, (*29)
<site-name>
Name of website.
[--ssl=<value>]
Enables ssl via letsencrypt certificate.
[--wildcard]
Gets wildcard SSL .
[--type=<type>]
Type of the site to be created. Values: html,php,wp etc.
[--skip-status-check]
Skips site status check.
EXAMPLES, (*30)
# 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
ee site restart --type=html
Runs the standard HTML site installation., (*31)
ee site restart --type=html <site-name> [--ssl=<value>] [--wildcard] [--type=<type>] [--skip-status-check]
OPTIONS, (*32)
<site-name>
Name of website.
[--ssl=<value>]
Enables ssl via letsencrypt certificate.
[--wildcard]
Gets wildcard SSL .
[--type=<type>]
Type of the site to be created. Values: html,php,wp etc.
[--skip-status-check]
Skips site status check.
EXAMPLES, (*33)
# 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
ee site share
Share a site online using ngrok., (*34)
ee site share <site-name> [--disable] [--refresh] [--token=<token>]
OPTIONS, (*35)
<site-name>
Name of website.
[--disable]
Take online link down.
[--refresh]
Refresh site share if link has expired.
[--token=<token>]
ngrok token.
EXAMPLES, (*36)
# 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
Clears Object and Page cache for site., (*37)
ee site clean [<site-name>] [--page] [--object]
OPTIONS, (*38)
[<site-name>]
Name of website to be enabled.
[--page]
Clear page cache.
[--object]
Clear object cache.
EXAMPLES, (*39)
# 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
Contributing
We appreciate you taking the initiative to contribute to this project., (*40)
Contributing isnât limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation., (*41)
Reporting a bug
Think youâve found a bug? Weâd love for you to help us get it fixed., (*42)
Before you create a new issue, you should search existing issues to see if thereâs an existing resolution to it, or if itâs already been fixed in a newer version., (*43)
Once youâve done a bit of searching and discovered there isnât an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible., (*44)
Creating a pull request
Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project., (*45)
Support
Github issues aren't for general support questions, but there are other venues you can try: https://easyengine.io/support/, (*46)
This README.md is generated dynamically from the project's codebase using ee scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase., (*47)
Wallogit.com
