From c02dcc770f01087e82d370a5eccd3a9256955c2a Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Thu, 3 Aug 2017 20:01:09 +0200 Subject: [PATCH] Add README Signed-off-by: Knut Ahlers --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..39485e9 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Luzifer / OTS + +`ots` is a one-time-secret sharing platform. The secret is encrypted with a symmetric 256bit AES encryption in the browser before being sent to the server. Afterwards an URL containing the ID of the secret and the password is generated. The password is never sent to the server so the server will never be able to decrypt the secrets it delivers with a reasonable effort. Also the secret is immediately deleted on the first read. + +## Features + +- AES 256bit encryption +- Server does never get the password +- Secret is deleted on first read + +## Setup + +- Download the [release](https://github.com/Luzifer/ots/releases) +- Start it and you can access the server on http://localhost:3000/ + +For a better setup you can choose the backend which is used to store the secrets: + +- `mem` - In memory storage (wiped on restart of the daemon) +- `redis` - Storing the secrets in a hash under one key + - `REDIS_URL` - Redis connection string `tcp://auth:PWD@HOST:PORT/DB` + - `REDIS_KEY` - Key to store the hash in (Default `io.luzifer.ots`)