This repository has been archived by the owner on Nov 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathKEYS.txt
70 lines (67 loc) · 6.81 KB
/
KEYS.txt
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
# Available keys #
All objects are lazy loaded and then a single object is reused after instantiation unless otherwise specified. Genearally the class used is specified by another key with the pattern '[object key] class'.
TODO: Find a good way to expose database options as command line arguments where appropriate.
## Fetcher Array Access keys ##
- 'build_hook_file.path' - The path to a file within the site that can be included to load additional build hooks.
- 'code_fetcher' - The instantiated code fetcher object.
- 'code_fetcher.class' - The class used to fetch the code for the site. This may download a fresh copy from Drupal or fetch the site using version control.
- 'code_fetcher.config' - An array, often containing a "branch" key.
- 'configuration.ephemeral' - An array of configuration that does not get persisted to the site_info.yaml and will not be reused across commands.
- 'database' - The database handler object used to perform database operations.
- 'database.admin.user.name' - The username used to perform administrative mysql tasks. This user needs to have permissions to create and drop users and datbases and to grant permissions.
- 'database.admin.user.password' - The password for the administrative user.
- 'database class' - The class used when the database handler is instantiated in the 'database' key.
- 'database.database' - The database (if applicable) that this site is installed in. Defaults to the value of 'name'.
- 'database.hostname' - The hostname of the database on which Drupal is or will be installed.
- 'database.newly_created' - If set and TRUE this specifies that this database was created during the execution of this process.
- 'database.port' - The port of the database on which Drupal is or will be installed.
- 'database_synchronizer' - The handler used to syncronize our database.
- 'database_synchronizer.class' - The class used to when the 'database synchronizer' is instantiated.
- 'database.user.hostname' - The hostname Drupal will be connecting from when connecting to the database (on the server the user is `'username'@'hostname'`).
- 'database.user.name' - The username Drupal will use to connect to the database.
- 'database.user.password' - The password Drupal will use to connect to the database.
- 'drush_alias.path' - The path of the drush alias file for this site.
- 'environments' - An array of environments.
- 'environment.remote' - The remote environment currently selected for synchronization operations.
- 'environment.local' - The environment that this instance of the site is running in or where it is being installed (defaults to `local` for local development).
- 'git binary' - The binary to use to execute git commands.
- 'hostname' - The hostname of this site, i.e. the url used to load this site.
- 'info_fetcher.class' - The class to be used to fetch information about sites and environments.
- 'info_fetcher' - The instantiated info fetcher handler object.
- 'log' - A closure used to do internal logging allowing drush logs to be extended or rerouted. Must implement the same interface as `drush_log`.
- 'log function' - A function matching the drush_log signature used by the default 'log' implementation to do logging. Defaults to `drush_log`.
- 'mysql.binary' - The binary to use to run MySQL. Defaults to `mysql` which must be in the inlcude path but an alternative may be set.
- 'name' - The site's local machine name.
- 'name.global' - The name this site has globally. This usually means the name of the site in the info fetcher. By default, this is the drush alias group the site belogns to.
- 'process' - A factory for Symfony\Process objects. Used to perform system calls.
- 'profile' - The install profile for this site. Usually only used in initial site creation.
- 'random' - A closure that generates pseudo random data. Defaults to a copy of the Drupal 7 drupal_random_bytes implementation.
- 'server' - The server handler object for interfacing with the application server that runs Drupal (likely Apache or nginx).
- 'server.webroot' - The folder that should contain the working directory of any fetcher working directories on an app server.
- 'server class' - The handler class for server operations.
- 'server.disable_site_command' - The command to run to disable a site on the server (e.g. `a2dissite sitename` on ubutnu.
- 'server.enable_site_command' - The command to run to enable a site on the server (e.g. `a2ensite sitename` on ubutnu.
- 'server.port' - The port to listen on for this virtualhost.
- 'server.sapi' - The supported sapi (apache supports fpm and mod_php).
- 'server.fpm_url' - The host and port to proxy requests to if the `server.sapi` key is set to `fpm`.
- 'server.restart_command' - The command to run to reload configuration (e.g. `service apache2 restart`).
- 'server.user' - The user that the webserver runs as (e.g. `apache2` runs as `www-data` on Ubuntu).
- 'settings_file.path' - The path to the site's settings.php file.
- 'settings_php.ini_set' - An associative arrays of ini_set() values keyed by setting name to be included in settings.php.
- 'settings_php.variables' - An associative array of variables to create keyed by setting name to be included in settings.php (may contain arrays).
- 'settings_php.requires' - A linear array of files to require from settings.php.
- 'simulate' - Whether to simulate opersations (should make no changes to the server).
- 'site' - The site (name of the folder withing the `sites` folder) on which we are acting. Defaults to `default`.
- 'site.directory' = The absolute path to the site folder (defaults to `[site.code_directory]/sites/[site]`).
- 'site.code_directory' - The folder containing Drupal's index.php.
- 'site.info path' - The path to the yaml file path. Defaults to `[site.working_directory]/site_info.yaml`.
- 'site.webroot' - The path to the webroot of the site as configured by apache. Generally a symlink.
- 'site.working_directory' - The working directory for this site. This folder will contain the public and private files, the webroot symlink, and any folders containg code, etc.
- 'symlinks' - An array of symlinks to create keyed by the link with the source of the real file or directory.
- 'system' - The handler object for loading data from or making changes to the system.
- 'system class' - The class used for the system object.
- 'system hostname' - The hostname of the system the site is installed on.
- 'title' - The human readible title of the site.
- 'verbose' - Whether to perform verbose logging. Generally triggered by drush's global verbose option.
- 'version' - The version of Drupal this site is on specified as an integer.
- 'webroot_subdirectory' - If there is a path within the code directory (usually for version control) that contains the actual webroot, this setting specifies that path. Defaults to `docroot`.