Update docs with correct secret file paths for destination-specific secrets #106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Destination-specific secret files are prefixed with a dot instead of a hyphen, according to https://github.com/basecamp/kamal/blob/8c32e6af07356031ffbad2e8eb60169904bc5e52/lib/kamal/secrets.rb#L10
visini
commented
Sep 27, 2024
| @@ -22,7 +22,7 @@ env: | |||
|
|
|||
| Kamal uses dotenv to automatically load environment variables set in the `.kamal/secrets` file. | |||
|
|
|||
| If you are using destinations, secrets will instead be read from `.kamal/secrets-<DESTINATION>` if it exists. | |||
| If you are using destinations, secrets will instead be read from `.kamal/secrets.<DESTINATION>` if it exists. | |||
|
|
|||
| Common secrets across all destinations can be set in `.kamal/secrets-common`. | |||
There was a problem hiding this comment.
Maybe after all secrets-<DESTINATION> would more sense, in order to be consistent with secrets-common?
There was a problem hiding this comment.
See also here: basecamp/kamal#933 (review)
There was a problem hiding this comment.
Thanks @visini! The docs are indeed wrong, secrets-common uses a dash so that you could have a destination called common.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Destination-specific secret files are actually looked up with a dot prefix (e.g.,
secrets.production) instead of a hyphen prefix (e.g.,secrets-production, as currently pointed out in the docs), according to https://github.com/basecamp/kamal/blob/8c32e6af07356031ffbad2e8eb60169904bc5e52/lib/kamal/secrets.rb#L10