search

acmcsufoss / acm-server

Terraform deployment files for acmCSUF.
MIT License
6 stars 2 forks source link

readme: add instructions for non-nix-shell #22

Closed amyipdev closed 4 months ago

amyipdev commented 4 months ago

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 amy@amyip.net

diamondburned commented 4 months ago

.env will be dropped once #21 is merged. I don't think it's feasible to support this use case, as it makes working with the repository a lot more annoying. Any server interaction done locally and not through the GitHub Actions should be assumed to require Nix.