readme: add instructions for non-nix-shell #22
Closed
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
This patch adds additional information to the README on necessary instructions for using the `acm-aws` repository without `nix-shell`. Environment variables stored in the `.env` are necessary for performing many `acm-aws` functions, including usage of the SSH script. Sourcing the `.env` is necessary to be able to use the SSH script. When logging in with `nix-shell`, the `.env` is automatically sourced, preventing users from having any issues. However, there are currently no indicators that the file needs to be sourced - `.env` is not even mentioned at all in the README. We don't currently specify in the README that `nix-shell` is a requirement - in fact, it is listed as optional/highly recommended - and thus non-nix-shell logins should be supported. Assuming basic dependencies (jq) are installed (doesn't even need Terraform or AWSCLI2), sourcing the `.env` (with `allexport`, as the file does not currently actually export the environment variables) and `./secrets` is decrypted (with proper permission overrides on the SSH key) is a sufficient condition for being able to log in with SSH. Signed-off-by: Amy Parker <[email protected]>
|
|
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.
This patch adds additional information to the README on necessary instructions for using the
acm-awsrepository withoutnix-shell.Environment variables stored in the
.envare necessary for performing manyacm-awsfunctions, including usage of the SSH script. Sourcing the.envis necessary to be able to use the SSH script.When logging in with
nix-shell, the.envis automatically sourced, preventing users from having any issues. However, there are currently no indicators that the file needs to be sourced -.envis not even mentioned at all in the README. We don't currently specify in the README thatnix-shellis a requirement - in fact, it is listed as optional/highly recommended - and thus non-nix-shell logins should be supported.Assuming basic dependencies (jq) are installed (doesn't even need Terraform or AWSCLI2), sourcing the
.env(withallexport, as the file does not currently actually export the environment variables) and./secretsis decrypted (with proper permission overrides on the SSH key) is a sufficient condition for being able to log in with SSH.Signed-off-by: Amy Parker [email protected]