Skip to content

Commit 0dd6e10

Browse files
committed
docs: correct casing/quoting on sentences
1 parent 60a95a7 commit 0dd6e10

File tree

3 files changed

+85
-53
lines changed

3 files changed

+85
-53
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,15 @@ Create a postgres service named lolipop:
7777
dokku postgres:create lolipop
7878
```
7979

80-
You can also specify the image and image version to use for the service. It *must* be compatible with the ${plugin_image} image.
80+
You can also specify the image and image version to use for the service. It *must* be compatible with the postgres image.
8181

8282
```shell
83-
export DATABASE_IMAGE="${PLUGIN_IMAGE}"
83+
export DATABASE_IMAGE="postgres"
8484
export DATABASE_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
8585
dokku postgres:create lolipop
8686
```
8787

88-
You can also specify custom environment variables to start the postgres service in semi-colon separated form.
88+
You can also specify custom environment variables to start the postgres service in semi-colon separated form.
8989

9090
```shell
9191
export DATABASE_CUSTOM_ENV="USER=alpha;HOST=beta"
@@ -181,7 +181,7 @@ flags:
181181
- `-a|--alias "BLUE_DATABASE"`: an alternative alias to use for linking to an app via environment variable
182182
- `-q|--querystring "pool=5"`: ampersand delimited querystring arguments to append to the service link
183183

184-
A postgres service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our 'playground' app.
184+
A postgres service can be linked to a container. This will use native docker links via the docker-options plugin. Here we link it to our 'playground' app.
185185

186186
> NOTE: this will restart your app
187187
@@ -212,14 +212,14 @@ The host exposed here only works internally in docker containers. If you want yo
212212
dokku postgres:link other_service playground
213213
```
214214

215-
It is possible to change the protocol for database_url by setting the environment variable database_database_scheme on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.
215+
It is possible to change the protocol for `DATABASE_URL` by setting the environment variable `POSTGRES_DATABASE_SCHEME` on the app. Doing so will after linking will cause the plugin to think the service is not linked, and we advise you to unlink before proceeding.
216216

217217
```shell
218-
dokku config:set playground DATABASE_DATABASE_SCHEME=postgres2
218+
dokku config:set playground POSTGRES_DATABASE_SCHEME=postgres2
219219
dokku postgres:link lolipop playground
220220
```
221221

222-
This will cause database_url to be set as:
222+
This will cause `DATABASE_URL` to be set as:
223223

224224
```
225225
postgres2://lolipop:SOME_PASSWORD@dokku-postgres-lolipop:5432/lolipop
@@ -264,13 +264,13 @@ dokku postgres:connect lolipop
264264
dokku postgres:enter <service>
265265
```
266266

267-
A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.
267+
A bash prompt can be opened against a running service. Filesystem changes will not be saved to disk.
268268

269269
```shell
270270
dokku postgres:enter lolipop
271271
```
272272

273-
You may also run a command directly against the service. Filesystem changes will not be saved to disk.
273+
You may also run a command directly against the service. Filesystem changes will not be saved to disk.
274274

275275
```shell
276276
dokku postgres:enter lolipop touch /tmp/test
@@ -283,10 +283,10 @@ dokku postgres:enter lolipop touch /tmp/test
283283
dokku postgres:expose <service> <ports...>
284284
```
285285

286-
Expose the service on the service's normal ports, allowing access to it from the public interface (0. 0. 0. 0):
286+
Expose the service on the service's normal ports, allowing access to it from the public interface (`0.0.0.0`):
287287

288288
```shell
289-
dokku postgres:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]}
289+
dokku postgres:expose lolipop 5432
290290
```
291291

292292
### unexpose a previously exposed postgres service
@@ -296,7 +296,7 @@ dokku postgres:expose lolipop ${PLUGIN_DATASTORE_PORTS[@]}
296296
dokku postgres:unexpose <service>
297297
```
298298

299-
Unexpose the service, removing access to it from the public interface (0. 0. 0. 0):
299+
Unexpose the service, removing access to it from the public interface (`0.0.0.0`):
300300

301301
```shell
302302
dokku postgres:unexpose lolipop
@@ -323,7 +323,7 @@ You can promote the new service to be the primary one:
323323
dokku postgres:promote other_service playground
324324
```
325325

326-
This will replace database_url with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:
326+
This will replace `DATABASE_URL` with the url from other_service and generate another environment variable to hold the previous value if necessary. You could end up with the following for example:
327327

328328
```
329329
DATABASE_URL=postgres://other_service:ANOTHER_PASSWORD@dokku-postgres-other-service:5432/other_service
@@ -401,7 +401,7 @@ Service scripting can be executed using the following commands:
401401
dokku postgres:app-links <app>
402402
```
403403

404-
List all postgres services that are linked to the 'playground' app.
404+
List all postgres services that are linked to the 'playground' app.
405405

406406
```shell
407407
dokku postgres:app-links playground
@@ -435,7 +435,7 @@ dokku postgres:clone lolipop lolipop-2
435435
dokku postgres:exists <service>
436436
```
437437

438-
Here we check if the lolipop postgres service exists.
438+
Here we check if the lolipop postgres service exists.
439439

440440
```shell
441441
dokku postgres:exists lolipop
@@ -448,7 +448,7 @@ dokku postgres:exists lolipop
448448
dokku postgres:linked <service> <app>
449449
```
450450

451-
Here we check if the lolipop postgres service is linked to the 'playground' app.
451+
Here we check if the lolipop postgres service is linked to the 'playground' app.
452452

453453
```shell
454454
dokku postgres:linked lolipop playground
@@ -461,7 +461,7 @@ dokku postgres:linked lolipop playground
461461
dokku postgres:links <service>
462462
```
463463

464-
List all apps linked to the 'lolipop' postgres service.
464+
List all apps linked to the 'lolipop' postgres service.
465465

466466
```shell
467467
dokku postgres:links lolipop
@@ -566,7 +566,7 @@ flags:
566566

567567
- `-u|--use-iam`: use the IAM profile associated with the current server
568568

569-
Backup the 'lolipop' service to the 'my-s3-bucket' bucket on aws:
569+
Backup the 'lolipop' service to the 'my-s3-bucket' bucket on ``AWS`:`
570570

571571
```shell
572572
dokku postgres:backup lolipop my-s3-bucket --use-iam
@@ -579,7 +579,7 @@ dokku postgres:backup lolipop my-s3-bucket --use-iam
579579
dokku postgres:backup-set-encryption <service> <passphrase>
580580
```
581581

582-
Set the gpg-compatible passphrase for encrypting backups for backups:
582+
Set the GPG-compatible passphrase for encrypting backups for backups:
583583

584584
```shell
585585
dokku postgres:backup-set-encryption lolipop
@@ -592,7 +592,7 @@ dokku postgres:backup-set-encryption lolipop
592592
dokku postgres:backup-unset-encryption <service>
593593
```
594594

595-
Unset the gpg encryption passphrase for backups:
595+
Unset the `GPG` encryption passphrase for backups:
596596

597597
```shell
598598
dokku postgres:backup-unset-encryption lolipop

0 commit comments

Comments
 (0)