/usr/share/doc/drush/examples/example.aliases.drushrc.php is in drush 4.5-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | <?php
/**
* Example of valid statements for an alias file. Use this
* file as a guide to creating your own aliases.
*
* Aliases are commonly used to define short names for
* local or remote Drupal installations; however, an alias
* is really nothing more than a collection of options.
* A canonical alias named "dev" that points to a local
* Drupal site named "dev.mydrupalsite.com" looks like this:
*
* $aliases['dev'] = array(
* 'root' => '/path/to/drupal',
* 'uri' => 'dev.mydrupalsite.com',
* );
*
* With this alias definition, then the following commands
* are equivalent:
*
* $ drush @dev status
* $ drush --root=/path/to/drupal --uri=dev.mydrupalsite.com status
*
* Any option that can be placed on the drush commandline
* can also appear in an alias definition.
*
* There are several ways to create alias files.
*
* + Put each alias in a separate file called ALIASNAME.alias.drushrc.php
* + Put multiple aliases in a single file called aliases.drushrc.php
* + Put groups of aliases into files called GROUPNAME.aliases.drushrc.php
*
* Drush will search for aliases in any of these files using
* the alias search path. The following locations are examined
* for alias files:
*
* 1. In any path set in $options['alias-path'] in drushrc.php,
* or (equivalently) any path passed in via --alias-path=...
* on the command line.
* 2. If 'alias-path' is not set, then in one of the default
* locations:
* a. /etc/drush
* b. In the drush installation folder
* c. Inside the 'aliases' folder in the drush installation folder
* d. $HOME/.drush
* 3. Inside the sites folder of any bootstrapped Drupal site,
* or any local Drupal site indicated by an alias used as
* a parameter to a command
*
* Files stored in these locations can be used to create aliases
* to local and remote Drupal installations. These aliases can be
* used in place of a site specification on the command line, and
* may also be used in arguments to certain commands such as
* "drush rsync" and "drush sql-sync".
*
* Alias files that are named after the single alias they contain
* may use the syntax for the canoncial alias shown at the top of
* this file, or they may set values in $options, just
* like a drushrc.php configuration file:
*
* $options['uri'] = 'dev.mydrupalsite.com',
* $options['root'] = '/path/to/drupal';
*
* When alias files use this form, then the name of the alias
* is taken from the first part of the alias filename.
*
* Alias groups (aliases stored together in files called
* GROUPNAME.aliases.drushrc.php, as mentioned above) also
* create an implicit namespace that is named after the group
* name.
*
* For example:
*
* # File: mysite.aliases.drushrc.php
* $aliases['dev'] = array(
* 'root' => '/path/to/drupal',
* 'uri' => 'dev.mydrupalsite.com',
* );
* $aliases['live'] = array(
* 'root' => '/other/path/to/drupal',
* 'uri' => 'mydrupalsite.com',
* );
*
* Then the following special aliases are defined:
*
* @mysite An alias named after the groupname
* may be used to reference all of the
* aliases in the group (e.g. drush @mydrupalsite status)
*
* @mysite.dev A copy of @dev
*
* @mysite.live A copy of @live
*
* Thus, aliases defined in an alias group file may be referred to
* either by their simple (short) name, or by thier full namespace-qualified
* name.
*
* To see an example alias definition for the current bootstrapped
* site, use the "site-alias" command with the built-in alias "@self":
*
* $ drush site-alias @self
*
* If you would like to see all of the Drupal sites at a specified
* root directory, use the built-in alias "@sites":
*
* $ drush -r /path/to/drupal site-alias @sites
*
* See 'drush help site-alias' for more options for displaying site
* aliases.
*
* Although most aliases will contain only a few options, a number
* of settings that are commonly used appear below:
*
* - 'uri': This should always be the same as the site's folder name
* in the 'sites' folder.
* - 'root': The Drupal root; must not be specified as a relative path.
* - 'remote-port': If the database is remote and 'db-url' contains
* a tunneled port number, put the actual database port number
* used on the remote machine in the 'remote-port' setting.
* - 'remote-host': The fully-qualified domain name of the remote system
* hosting the Drupal instance. The remote-host option must be
* omitted for local sites, as this option controls whether or not
* rsync parameters are for local or remote machines.
* - 'remote-user': The username to log in as when using ssh or rsync.
* - 'ssh-options': If the target requires special options, such as a non-
* standard port, alternative identity file, or alternative
* authentication method, ssh- options can contain a string of extra
* options that are used with the ssh command, eg "-p 100"
* - 'parent': The name of a parent alias (e.g. '@server') to use as a basis
* for this alias. Any value of the parent will appear in the child
* unless overridden by an item with the same name in the child.
* Multiple inheritance is possible; name multiple parents in the
* 'parent' item separated by commas (e.g. '@server,@devsite').
* - 'db-url': The Drupal 6 database connection string from settings.php.
* For remote databases accessed via an ssh tunnel, set the port
* number to the tunneled port as it is accessed on the local machine.
* If 'db-url' is not provided, then drush will automatically look it
* up, either from settings.php on the local machine, or via backend invoke
* if the target alias specifies a remote server.
* - 'databases': Like 'db-url', but contains the full Drupal 7 databases
* record. Drush will look up the 'databases' record if it is not specified.
* - 'path-aliases': An array of aliases for common rsync targets.
* Relative aliases are always taken from the Drupal root.
* '%drush-script': The path to the 'drush' script, or to 'drush.php' or
* 'drush.bat', as desired. This is used by backend invoke when drush
* runs a drush command. The default is 'drush' on remote machines, or
* the full path to drush.php on the local machine.
* '%drush': A read-only property: points to the folder that the drush script
* is stored in.
* '%dump-dir': Path to directory that "drush sql-sync" should use to store
* sql-dump files. Helpful filenames are auto-generated.
* '%dump': Path to the file that "drush sql-sync" should use to store sql-dump file.
* '%files': Path to 'files' directory. This will be looked up if not specified.
* '%root': A reference to the Drupal root defined in the 'root' item
* in the site alias record.
* - 'command-specific': These options will only be set if the alias
* is used with the specified command. In the example below, the option
* `--no-cache` will be selected whenever the @stage alias
* is used in any of the following ways:
* drush @stage sql-sync @self @live
* drush sql-sync @stage @live
* drush sql-sync @live @stage
* In case of conflicting options, command-specific options in targets
* (source and destination) take precedence over command-specific options
* in the bootstrapped site, and command-specific options in a destination
* alias will take precedence over those in a source alias.
* - 'source-command-specific' and 'target-command-specific': Behaves exactly
* like the 'command-specific' option, but is applied only if the alias
* is used as the source or target, respectively, of an rsync or sql-sync
* command. In the example below, `--skip-tables-list=comments` whenever
* the alias @live is the target of an sql-sync command, but comments will
* be included if @live is the source for the sql-sync command.
* Some examples appear below. Remove the leading hash signs to enable.
*/
#$aliases['stage'] = array(
# 'uri' => 'stage.mydrupalsite.com',
# 'root' => '/path/to/remote/drupal/root',
# 'db-url' => 'pgsql://username:password@dbhost.com:port/databasename',
# 'remote-host' => 'mystagingserver.myisp.com',
# 'remote-user' => 'publisher',
# 'path-aliases' => array(
# '%drush' => '/path/to/drush',
# '%drush-script' => '/path/to/drush/drush',
# '%dump-dir' => '/path/to/dumps/',
# '%files' => 'sites/mydrupalsite.com/files',
# '%custom' => '/my/custom/path',
# ),
# 'command-specific' => array (
# 'sql-sync' => array (
# 'no-cache' => TRUE,
# ),
# ),
# );
#$aliases['dev'] = array(
# 'uri' => 'dev.mydrupalsite.com',
# 'root' => '/path/to/drupal/root',
# );
#$aliases['server'] = array(
# 'remote-host' => 'mystagingserver.myisp.com',
# 'remote-user' => 'publisher',
# );
#$aliases['live'] = array(
# 'parent' => '@server,@dev',
# 'uri' => 'mydrupalsite.com',
# 'target-command-specific' => array (
# 'sql-sync' => array (
# 'skip-tables-list' => 'comments',
# ),
# ),
# );
|