From e70b8d08d9a6e587729102f2c3c6a1614286eef2 Mon Sep 17 00:00:00 2001 From: LeeW Date: Fri, 7 Mar 2025 09:38:30 +0100 Subject: [PATCH] ADP-216: updates README from UAT feedback for step2 - make procedural --- README.md | 40 ++++++++++++++-------------------------- 1 file changed, 14 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 21a5253..ff0e6fe 100644 --- a/README.md +++ b/README.md @@ -98,8 +98,8 @@ Note: For a worked-through example, see next section. 1. git: push branch - CLI: `git push -u origin add_pubkey_[firstname]-[lastname]` 1. gitlab: open a MergeRequest, Review, Merge - 1. **Status**: New User has access to SOPS-Encrypted Secrets within Project Repo - 1. **Hand-Off**: Proceed to next steps; Instruct New User to verify access to secrets +1. **Status**: New User has access to SOPS-Encrypted Secrets within Project Repo +1. **Hand-Off**: Proceed to next steps; Instruct New User to verify access to secrets #### Example @@ -164,30 +164,18 @@ SOPS is used for encrypting secrets, e.g. credentials for various systems ## Install -### 1. Install Sops - -https://github.com/getsops/sops - -Note: -* MacOS: If desired, one can also use brew to install sops: `brew install sops`; although this is not officially maintained, [the formula is essentially the same as the official installation instructions](https://github.com/Homebrew/homebrew-core/blob/4496ce5131bc09e7065fa0aa8fb96366a3df6477/Formula/s/sops.rb) - -### 2. Configure - -Add the following to your `~/.bashrc` or `~/.zshrc` - but _not_ to your `~/.profile` as it must be set per session: - -```shell -# Enable interactive passphrase prompt for SOPS -export GPG_TTY=$(tty) -``` - -### 3. Verify - -Run the following command to verify local SOPS installation _and_ key configuration: - -```shell -# Follow the interactive prompts: -./verify/usr_confirm_keycfg.sh -``` +1. **Install Sops** + 1. https://github.com/getsops/sops + - Note: + * MacOS: If desired, one can also use brew to install sops: `brew install sops`; although this is not officially maintained, [the formula is essentially the same as the official installation instructions](https://github.com/Homebrew/homebrew-core/blob/4496ce5131bc09e7065fa0aa8fb96366a3df6477/Formula/s/sops.rb) +1. **Configure Sops** + * Add the following to your `~/.bashrc` or `~/.zshrc` - but _not_ to your `~/.profile` as it must be set per session: + ```shell + # Enable interactive passphrase prompt for SOPS + export GPG_TTY=$(tty) + ``` +1. **Verify SOPS Installation and Key Configuration** + 1. `./verify/usr_confirm_keycfg.sh` ## Usage