Warning for MacOS etc symlink #28
Open
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
|
|
tomhjp
reviewed
May 19, 2023
| @@ -23,6 +23,7 @@ GitHub. Alternatively you can compile the plugin from source. | |||
| ```sh | |||
| $ mv vault-auth-plugin-example /etc/vault/plugins/vault-auth-plugin-example | |||
| ``` | |||
| Note that on MacOS, the etc directory is a symlink. Vault does not allow symlink directories for plugins. | |||
There was a problem hiding this comment.
/etc/ is also kind of a weird recommendation anyway. WDYT about just changing this command (and the SHA256 calculation below) to a user-defined variable? e.g. $ mv vault-auth-plugin-example "$plugin_dir"
There was a problem hiding this comment.
Although probably worth keeping this note in some form either way, as we can still mention $plugin_dir shouldn't contain any symlinks.
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.
Overview
This updates the README with a warning regarding /etc/ being a symlink on MacOS as that can be a pitfall for someone following the tutorial on Mac.
Considered other approaches such as being more prescriptive with the steps of the Vault setup. Happy to redo if another approach is in mind.
Design of Change
It is a one-line addition to the README to warn users.
Related Issues/Pull Requests
Issue #25
Will require a minor update if PR #27 is merged.
Contributor Checklist
README update