aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/commands/credentials/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/rails/commands/credentials/USAGE')
-rw-r--r--railties/lib/rails/commands/credentials/USAGE14
1 files changed, 14 insertions, 0 deletions
diff --git a/railties/lib/rails/commands/credentials/USAGE b/railties/lib/rails/commands/credentials/USAGE
index c8d3fb9eda..0396fcb403 100644
--- a/railties/lib/rails/commands/credentials/USAGE
+++ b/railties/lib/rails/commands/credentials/USAGE
@@ -30,6 +30,20 @@ You could prepend that to your server's start command like this:
RAILS_MASTER_KEY="very-secret-and-secure" server.start
+=== Set up Git to Diff Credentials
+
+Rails provides `rails credentials:diff --enable` to instruct Git to call `rails credentials:diff`
+when `git diff` is run on a credentials file.
+
+Any credentials files are set to use the "rails_credentials" diff driver in .gitattributes.
+Since Git requires the diff driver to be set up in a config file, the command uses
+the project local .git/config. Since that config isn't stored in Git each team member
+must enable separately.
+
+Or set up the "rails_credentials" diff driver globally with:
+
+ git config --global diff.rails_credentials.textconv "bin/rails credentials:diff"
+
=== Editing Credentials
This will open a temporary file in `$EDITOR` with the decrypted contents to edit