diff --git a/README.md b/README.md index 71f58ff..edc0a45 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,27 @@ This crate is a work in progress. See the documentation for further information: . +## 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 diff --git a/rustfmt.toml b/rustfmt.toml new file mode 100644 index 0000000..0a712a8 --- /dev/null +++ b/rustfmt.toml @@ -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