Skip to content

Commit 483a5fb

Browse files
authored
Improve drush config docs
1 parent 042a3a3 commit 483a5fb

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

docs/using-drush-configuration.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ drush:
9292
```yml
9393
options:
9494
# Specify the base_url that should be used when generating links.
95-
uri: 'http://example.com/subdir'
95+
uri: 'https://example.com/subdir'
9696
9797
# Load Drush config from a non-standard location
9898
config: '/home/USER/workspace/drupal'
@@ -104,6 +104,13 @@ options:
104104
#### Command-specific options
105105
```yml
106106
command:
107+
# Disabling the admin super user account (uid #1) is recommended.
108+
# Use this to specify another admin account for the uli command.
109+
# See https://www.drupal.org/docs/administering-a-drupal-site/security-in-drupal/securing-the-admin-super-user-1
110+
user:
111+
login:
112+
options:
113+
name: newadmin
107114
sql:
108115
cli:
109116
options:
@@ -123,7 +130,6 @@ command:
123130
options:
124131
# Ensure all rsync commands use verbose output.
125132
verbose: true
126-
127133
site:
128134
install:
129135
options:

examples/example.drush.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ drush:
1919
# Global options.
2020
options:
2121
# Specify the base_url that should be used when generating links.
22-
# uri: 'http://example.com/subdir'
22+
# uri: 'https://example.com/subdir'
2323

2424
# Command-specific options.
2525
command:
@@ -29,12 +29,13 @@ command:
2929
user:
3030
login:
3131
options:
32-
name: newadminuser
32+
name: newadmin
3333
sql:
3434
dump:
3535
options:
36-
# Uncomment to omit cache and similar tables (including during a sql:sync).
37-
# structure-tables-key: common
36+
# Omit cache and similar tables (including during a sql:sync).
37+
# Define tables to exclude under sql section.
38+
structure-tables-key: common
3839

3940
# Non-options.
4041
ssh:

0 commit comments

Comments
 (0)