Skip to content

Sites

A "site" on DDEV-Live is a project which has information attached to it and which can be referenced in commands.

<site> is what you want to call your project on DDEV-Live. It must consist of lower case alphanumeric characters or ''-'', start with an alphabetic character, and end with an alphanumeric character.

GitHub

To create your project on DDEV-Live and import code from GitHub with the default settings, run:

$ ddev-live create site drupal <org>/<site> --github-repo <github-org>/<repo-name> [flags]

You can add flags for specific configuration options. Use a command as follows to see all possible flags and their descriptions:

$ ddev-live create site wordpress -h

GitLab

The previous command is tightly coupled with the GitHub API and GitHub Apps, and therefore it does not support any other Git hosts. As we are gradually introducing integrations with more third-party tools and platforms, for GitLab we have added more universal set of flags that are agnostic of the Git hosting provider and newly support not only branches but also tags and any other valid Git revisions:

$ ddev-live create site drupal <org>/<site> --git-repo <git-repository-url> --git-rev <branch/tag/commit> [flags]

Working with your site on DDEV-Live

DDEV-Live "watches" the specified branch of your repo. When you push updates to the repo, DDEV-Live will redeploy the site. This will take a few minutes to complete.

  • View a list of all the sites within a specified organization with ddev-live list sites --org <org>.
  • View the state of a specific site with ddev-live describe site <org>/<site>.
  • Use ddev-live config to modify the GitHub repo or branch to pull from.
  • Use ddev-live delete to delete a resource. For example, ddev-live delete site <org>/<site>.

Example of a site creation command with describe site command:

$ ddev-live create site drupal my-drupal-site \
    --github-repo ddev-demo/multilingual --branch master \
    --drupal-version 8 \
    --run-composer-install \
    --tag=drupal,testing,expires \
    --expires-in 2d

For site status, run:
  ddev-live describe site ddev-demo/my-drupal-site

$ ddev-live describe site ddev-demo/my-drupal-site

SITE INFO
 Name:          my-drupal-site
 Org:           ddev-demo
 Tags:           
  - expires
  - testing
  - drupal
 Created:       5m ago (2020-08-20 14:48:28 +0200 CEST)
 Expires:       in 2d (2020-08-22 14:48:28 +0200 CEST) 
 Type:          Drupal
 Version:       8
 PHP Version:   7.2
 Healthy:       true
 Updated:       2m ago (2020-08-20 14:51:09 +0200 CEST)
 Info:          PHPApp my-drupal-site is provisioned
 Preview URL:   http://preview-my-drupal-site-ddev-demo.sites.ddev.live
 Cron Status:   enabled
 Cron Schedule: 

SITE IMAGE
 Created:       4m ago (2020-08-20 14:48:52 +0200 CEST)
 Run Composer:  true
 Composer Args: 
 Status:
 GIT SOURCE 
  URL:           https://github.com/ddev-demo/multilingual
  Revision:      master
  CurrentCommit: e477ae98bda87cf081e8652a9a35aa5de276b88f
  Status:        

SITE
 Healthy: true
 Updated: 2m ago (2020-08-20 14:51:09 +0200 CEST)
 Info:    PHPApp my-drupal-site is provisioned

FILESTORE
 Healthy: true
 Updated: 3m ago (2020-08-20 14:49:48 +0200 CEST)
 Info:    FileStore my-drupal-site is provisioned

DATABASE
 Healthy: true
 Updated: 3m ago (2020-08-20 14:49:48 +0200 CEST)
 Info:    MySQLDB my-drupal-site is provisioned in default-mfv57 MySQLServer
 AUTOMATED BACKUPS
  Enabled:  false
  Schedule: Not set
  Retain:   0

ENVIRONMENT
 DRUPAL_TRUSTED_HOST_PATTERN=(127\.0\.0\.1)|(localhost)|(preview-my-drupal-site-ddev-demo\.sites\.ddev\.live)

HOSTS
 No custom host configuration

Setting expiration on your site

Optionally, you can set a site to expire anywhere from 30 minutes to 5 days from the creation timestamp with the --expires-in flag. It can be set during initial site creation or configured later. When the site reaches the expiration time, it will be automatically deleted from DDEV-Live. This is useful when creating disposable testing or preview sites.

Example for creating a site that will expire in 90 minutes.

$ ddev-live create site drupal <org>/<site> --github-repo <github-org>/<repo-name> --expires-in 90m

Extending or shortening the expiration sets the expiration time relative to the site creation time and can never extend beyond 5 days total from site creation.
This example will set the expiration to 4 days from when the site was created.

$ ddev-live config drupal <site> --expires-in 4d

Here is a handy command to filter through your sites for all that have expiration set and sort by which one expires earliest:

$ ddev-live list sites -o json --format-time-as-seconds | jq -c '[.sites[] | select(.expires != "")] | sort_by(.expires) | .[]'

The flag -o json sets the output from plaintext to JSON formatted, the second flag --format-time-as-seconds converts the human readable duration and time to seconds and timestamp so it can be conveniently passed to other tools, such as jq, for additional processing.


Last update: 2020-10-19