#storage #mongo-db #interface #server #redact #top #back-end

app redact-store

Provides a common interface on top of storage backings

11 stable releases

1.2.16 Jul 27, 2022
1.2.11 Dec 7, 2021
1.2.0 Sep 24, 2021
1.0.1 Jul 16, 2021
0.2.8 Jul 16, 2021

#816 in Database interfaces

26 downloads per month

Custom license

645 lines


License: GPL-3.0 crates.io docs.rs Coverage Status

redact-store is a storage server


redact-store currently only supports being run with a MongoDB back-end, although more will be added in the future. There are a couple options for getting a free mongo database:

  1. Get a 100% free, fully-managed database at mongodb.com (easier, available from any device)
  2. Host it locally by installing and running mongo (harder, only available locally)

The storage server simply takes in a connection string and database name and is agnostic to where the database is hosted.


  1. git clone https://github.com/pauwels-labs/redact-crypto
  2. echo "export REDACT_DB_URL=\"<mongo connection string>\"" >> config/config.env
  3. echo "export REDACT_DB_NAME=\"<db name>\"" >> config/config.env
  4. source config/config.env
  5. cargo r


  • Get data route. This route takes in a data path and will return the data at that path if it exists.
    • GET /<path>
    • <path> is a jsonpath-style string prepended and appended by a period, e.g. .profile.firstName.
  • Post data route. This route access an entire data entry and will store it in the database if possible.
    • POST /
    • The body of the request should be an Entry struct serialized as JSON


To run unit tests:

  1. cargo t

To run unit tests+code coverage output (does not work on macos or windows):

  1. cargo install tarpaulin
  2. cargo tarpaulin -o html

Docs & Support

Docs are available at docs.redact.ws.

Join us in our Keybase channel! You can download the keybase client here.

Once there, click on Teams, select Join a team, and our team name is pauwelslabs.

Once you're in, Redact discussion happens in the #redact channel.

Discussions in the Keybase team should be respectful, focused on Redact, and free of profanity.


~1M SLoC