Skip to content

Commit 6697e8b

Browse files
authored
Merge pull request #328 from ryantm/doc-strip-whitespace
doc: strip trailing whitespace
2 parents 8a4516a + bd33a9b commit 6697e8b

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
`agenix` is a small and convenient Nix library for securely managing and deploying secrets using common public-private SSH key pairs:
44
You can encrypt a secret (password, access-token, etc.) on a source machine using a number of public SSH keys,
5-
and deploy that encrypted secret to any another target machine that has the corresponding private SSH key of one of those public keys.
6-
This project contains two parts:
5+
and deploy that encrypted secret to any another target machine that has the corresponding private SSH key of one of those public keys.
6+
This project contains two parts:
77
1. An `agenix` commandline app (CLI) to encrypt secrets into secured `.age` files that can be copied into the Nix store.
88
2. An `agenix` NixOS module to conveniently
99
* add those encrypted secrets (`.age` files) into the Nix store so that they can be deployed like any other Nix package using `nixos-rebuild` or similar tools.
@@ -250,7 +250,7 @@ To install the `agenix` binary:
250250
```nix
251251
{
252252
inputs.agenix.url = "github:ryantm/agenix";
253-
253+
254254
outputs = { self, nixpkgs, agenix, home-manager }: {
255255
homeConfigurations."username" = home-manager.lib.homeManagerConfiguration {
256256
# ...
@@ -316,7 +316,7 @@ e.g. inside your `flake.nix` file:
316316
$ cd secrets
317317
$ touch secrets.nix
318318
```
319-
This `secrets.nix` file is **not** imported into your NixOS configuration.
319+
This `secrets.nix` file is **not** imported into your NixOS configuration.
320320
It's only used for the `agenix` CLI tool (example below) to know which public keys to use for encryption.
321321
3. Add public keys to your `secrets.nix` file:
322322
```nix
@@ -335,7 +335,7 @@ e.g. inside your `flake.nix` file:
335335
}
336336
```
337337
These are the users and systems that will be able to decrypt the `.age` files later with their corresponding private keys.
338-
You can obtain the public keys from
338+
You can obtain the public keys from
339339
* your local computer usually in `~/.ssh`, e.g. `~/.ssh/id_ed25519.pub`.
340340
* from a running target machine with `ssh-keyscan`:
341341
```ShellSession
@@ -356,7 +356,7 @@ e.g. inside your `flake.nix` file:
356356
age.secrets.secret1.file = ../secrets/secret1.age;
357357
}
358358
```
359-
When the `age.secrets` attribute set contains a secret, the `agenix` NixOS module will later automatically decrypt and mount that secret under the default path `/run/agenix/secret1`.
359+
When the `age.secrets` attribute set contains a secret, the `agenix` NixOS module will later automatically decrypt and mount that secret under the default path `/run/agenix/secret1`.
360360
Here the `secret1.age` file becomes part of your NixOS deployment, i.e. moves into the Nix store.
361361

362362
6. Reference the secrets' mount path in your config:
@@ -372,14 +372,14 @@ e.g. inside your `flake.nix` file:
372372
So `config.age.secrets.secret1.path` will contain the path `/run/agenix/secret1` by default.
373373
7. Use `nixos-rebuild` or [another deployment tool](https://nixos.wiki/wiki/Applications#Deployment") of choice as usual.
374374

375-
The `secret1.age` file will be copied over to the target machine like any other Nix package.
375+
The `secret1.age` file will be copied over to the target machine like any other Nix package.
376376
Then it will be decrypted and mounted as described before.
377377
8. Edit secret files:
378378
```ShellSession
379379
$ agenix -e secret1.age
380380
```
381-
It assumes your SSH private key is in `~/.ssh/`.
382-
In order to decrypt and open a `.age` file for editing you need the private key of one of the public keys
381+
It assumes your SSH private key is in `~/.ssh/`.
382+
In order to decrypt and open a `.age` file for editing you need the private key of one of the public keys
383383
it was encrypted with. You can pass the private key you want to use explicitly with `-i`, e.g.
384384
```ShellSession
385385
$ agenix -e secret1.age -i ~/.ssh/id_ed25519
@@ -659,7 +659,7 @@ secret. This is the only required secret option.
659659
#### `age.secrets.<name>.path`
660660

661661
`age.secrets.<name>.path` is the path where the secret is decrypted
662-
to. Defaults to `$XDG_RUNTIME_DIR/agenix/<name>` on Linux and
662+
to. Defaults to `$XDG_RUNTIME_DIR/agenix/<name>` on Linux and
663663
`$(getconf DARWIN_USER_TEMP_DIR)/agenix/<name>` on Darwin.
664664

665665
#### `age.secrets.<name>.mode`
@@ -681,13 +681,13 @@ This is a required option; there is no default value.
681681
#### `age.secretsDir`
682682

683683
`age.secretsDir` is the directory where secrets are symlinked to by
684-
default. Defaults to `$XDG_RUNTIME_DIR/agenix` on Linux and
684+
default. Defaults to `$XDG_RUNTIME_DIR/agenix` on Linux and
685685
`$(getconf DARWIN_USER_TEMP_DIR)/agenix` on Darwin.
686686

687687
#### `age.secretsMountPoint`
688688

689689
`age.secretsMountPoint` is the directory where the secret generations
690-
are created before they are symlinked. Defaults to `$XDG_RUNTIME_DIR/agenix.d`
690+
are created before they are symlinked. Defaults to `$XDG_RUNTIME_DIR/agenix.d`
691691
on Linux and `$(getconf DARWIN_USER_TEMP_DIR)/agenix.d` on Darwin.
692692

693693
### agenix CLI reference

0 commit comments

Comments
 (0)