Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for PR #715 #51

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/Getting Started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,19 @@ called `PRODUCTION_USERNAME` and `PRODUCTION_PASSWORD`, and use those values for

If you use the [dotenv](https://www.npmjs.com/package/dotenv) package to manage environment variables, db-migrate will automatically load it.

You can provide a default value to use when an environment variable is not set on a given machine. This is useful
for setting defaults for the dev environment, and for changing optional settings that need a default to operate.
```json
{
"pg": {
"driver": "pg",
"user": {"ENV": "PG_USERNAME", "default": "postgres"},
"password": {"ENV": "PG_PASSWORD", "default": "password"}
}
}
```


Note that if the settings for an environment are represented by a single string that string will be parsed as a database URL.

You can pass the -e or --env option to db-migrate to select the environment you want to run migrations against. The --config option can be used to specify the path to your database.json file if it's not in the current working directory.
Expand Down