Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanisaacs committed Nov 9, 2021
1 parent 13cd57d commit 0388d8c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,18 @@ Runtime: Files are stored unencrypted in `/run/user/$UID/secrets` and can be sym

Notes (in progress [fixes](https://github.com/jordanisaacs/homeage/issues/8#issue-1047731755)):

1. Currently all `home.file.<name>.symlinks` are not cleaned up on new home-manager generation. Therefore a symlink that points to a decrypted yaml file named `hello` in one generation, instead of being deleted will point to a png file named `hello` in the next.
1. All `home.file.<name>.symlinks` are not cleaned up on new home-manager generation. Therefore a symlink that points to a decrypted yaml file named `hello` in one generation, instead of being deleted will point to a png file named `hello` in the next.

2. Currently the `/run` secrets folder is not cleaned on home-manager activation. Therefore old secrets will exist decrypted until reboot.
2. The `/run` secrets folder is not cleaned on home-manager activation. Therefore old secrets will exist decrypted until reboot.

3. Use the `cpOnService` at your own risk, as cleanup is not implemented the decrypted file will exist until manually deleted

## Roadmap

- [ ] Implement cleanup
- [ ] Support passphrases
- [ ] Support unencrypted with public key files
- [ ] Add activation checks
- [ ] Add tests

## Getting started
Expand Down
6 changes: 6 additions & 0 deletions options.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,9 @@
- *Description*: Group of the decrypted file
- *Default*: `"$(id -g)"`
- *Type*: `types.str`

**homeage.file.\<name\>.cpOnService**:

- *Description*: Copy the decrypted file to path when decryption service runs. Use at own risk (no cleanup so file must be deleted manually)
- *Default*: `[ ]`
- *Type*: `types.str`

0 comments on commit 0388d8c

Please sign in to comment.