www.aleph1.co.uk Git - yaffs-website/blob - vendor/drush/drush/src/Commands/generate/Generators/Drush/drush-alias-file.twig

   1 # Although most aliases will contain only a few options, a number
   2 # of settings that are commonly used appear below:
   3 #
   4 # - 'uri': The value of --uri should always be the same as
   5 #   when the site is being accessed from a web browser (e.g. http://example.com)
   6 # - 'root': The Drupal root; must not be specified as a relative path.
   7 # - 'host': The fully-qualified domain name of the remote system
   8 #   hosting the Drupal instance. **Important Note: The remote-host option
   9 #   must be omitted for local sites, as this option controls various
  10 #   operations, such as whether or not rsync parameters are for local or
  11 #   remote machines, and so on. @see hook_drush_sitealias_alter() in drush.api.php
  12 # - 'user': The username to log in as when using ssh or rsync.
  13 # - 'os': The operating system of the remote server.  Valid values
  14 #   are 'Windows' and 'Linux'. Be sure to set this value for all remote
  15 #   aliases because the default value is PHP_OS if 'remote-host'
  16 #   is not set, and 'Linux' (or $options['remote-os']) if it is. Therefore,
  17 #   if you set a 'remote-host' value, and your remote OS is Windows, if you
  18 #   do not set the 'OS' value, it will default to 'Linux' and could cause
  19 #   unintended consequences, particularly when running 'drush sql-sync'.
  20 # - 'ssh': If the target requires special options, such as a non-
  21 #   standard port, alternative identity file, or alternative
  22 #   authentication method, the `option` entry under the `ssh` item may
  23 #   contain a string of extra options that are used with the ssh command,
  24 #   e.g. "-p 100"
  25 # - 'paths': An array of aliases for common rsync targets.
  26 #   Relative aliases are always taken from the Drupal root.
  27 #   - 'files': Path to 'files' directory.  This will be looked up if not
  28 #     specified.
  29 #   - 'drush-script': Path to the remot Drush command.
  30 # - 'command': These options will only be set if the alias
  31 #   is used with the specified command.  In the example below, the option
  32 #   `--no-dump` will be selected whenever the @stage alias
  33 #   is used in any of the following ways:
  34 #     - `drush @stage sql-sync @self @live`
  35 #     - `drush sql-sync @stage @live`
  36 #     - `drush sql-sync @live @stage`
  37 #   NOTE: Setting boolean options broke with Symfony 3. This will be fixed
  38 #     in a future release. See: https://github.com/drush-ops/drush/issues/2956
  39 #
  40 # Complex example:
  41 #
  42 # @code
  43 # # File: remote.alias.yml
  44 # live:
  45 #   host: server.domain.com
  46 #   user: www-admin
  47 #   root: /other/path/to/drupal
  48 #   uri: http://example.com
  49 #   ssh:
  50 #     options: '-p 100'
  51 #   paths:
  52 #     drush-script: '/path/to/drush'
  53 #   command:
  54 #     site:
  55 #       install:
  56 #         options:
  57 #           admin-password: 'secret-secret'
  58 # @endcode
  59 #
  60 # Altering aliases:
  61 #
  62 # See examples/Commands/SiteAliasAlter.php for an example.
  63
  64 dev:
  65   root: {{ root }}
  66   uri: {{ uri }}
  67 {% if host %}
  68   host: {{ host }}
  69   user: {{ user }}
  70 {% endif %}