mrrobot47/site-command

Thursday, July 26, 2018
by mrrobot47
Repository
2 Watchers
0 Stars
90 Installations

PHP
2 Dependents
0 Suggesters
5 Forks
0 Open issues
54 Versions
0 % Grown

The README.md

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

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)

The Versions

26/07 2018

dev-refactor-for-packages

dev-refactor-for-packages https://github.com/easyengine/site-command

ee-cli-package site-command

mrrobot47/site-command

The README.md

easyengine/site-command

Using

ee site create --type=html

ee site delete

ee site update

ee site create --type=html

ee site enable

ee site disable

ee site ssl

ee site info

ee site list

ee site reload --type=html

ee site restart --type=html

ee site share

ee site clean

Contributing

Reporting a bug

Creating a pull request

Support

The Versions

dev-refactor-for-packages

dev-master

The Requires

dev-develop

The Requires

dev-update/readme-for-similarity

The Requires

dev-update/defaults

The Requires

dev-update/webroot

The Requires

dev-travis/cache-composer

The Requires

dev-update/site-services

The Requires

dev-fix/comoplete-cert-deletion

The Requires

dev-fix/complete-cert-deletion

The Requires

dev-fix/cert-management

The Requires

dev-travis/add-tests-and-integration

The Requires

dev-travis/add-test-and-integration

The Requires

dev-fix/highlight-imp-msg

The Requires

dev-feature/write-mail-to-config

The Requires

dev-update/delete-for-le

The Requires

dev-update/readme-for-beta3

The Requires

dev-update/site-status-chk-for-le

The Requires

dev-tag/global-image

dev-add/delete-confirmation

dev-feature/tagging-images

dev-feature/acmephp-letsencrypt

The Requires

dev-update/docker-file-for-vhost-in-php

dev-feature/port-to-jwilder-nginx-proxy

dev-feature/remote-database

The Requires

dev-temp

The Requires

dev-update/log_msgs

The Requires

dev-fix/add-error-msg

The Requires

dev-fix/info-auto-detect

The Requires

dev-fix/php-image-chown

The Requires

dev-fix/auto-sitename-detect

The Requires

dev-feature/auto-sitename-detect