Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tgross35 committed Nov 14, 2023
1 parent f1aadee commit aae64d2
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,27 @@ This crate is a work in progress.

See the documentation for further information: <https://docs.rs/clevis>.

## Tang Setup

You need a tang server running in order to use this crate. The
[padhihomelab/tang](https://hub.docker.com/r/padhihomelab/tang) image is the
easiest way to get started with this.

```sh
docker run --rm -d \
-v $(pwd)/tang-db:/db \
-e ENABLE_IPv6=1 \
-p 11697:8080 \
--name tang-backend \
padhihomelab/tang
```

This will store the Tang keys in the directory at `./tang-db`, adjust this as
needed.

Any port can be selected (this crate uses `11697` for examples since it is the
ASCII of `ta` (as in `tang`), so easy to remember).

## Licensing

Since this project takes heavy influence from the original [clevis], it retains
Expand Down
7 changes: 7 additions & 0 deletions rustfmt.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Most of these are nightly only, but they are needed
imports_granularity = "Module"
newline_style = "Unix"
group_imports = "StdExternalCrate"
format_code_in_doc_comments = true
format_macro_bodies = true
format_macro_matchers = true

0 comments on commit aae64d2

Please sign in to comment.