Skip to content

Commit

Permalink
Add a usecase description to README
Browse files Browse the repository at this point in the history
Signed-off-by: Igor Shishkin <me@teran.dev>
  • Loading branch information
teran committed May 12, 2024
1 parent 1af0e98 commit bcb1d65
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,13 @@

Trivial library, example server and client applications to provide secrets for
applications from third party password manager authenticated once.

## Use case

Secretbox provides ability to run any other application which can obtain
secrets from a command (like [restic](https://restic.net) or
[rclone](https://rclone.org)) to get the secrets it needs with one-time
token through unix-socket. In that scenario service side must be used
to serve unix-socket connections by application runner.

Examples can be found in cmd: cli and server side.

0 comments on commit bcb1d65

Please sign in to comment.