Skip to content

Commit

Permalink
README and usage docs updated
Browse files Browse the repository at this point in the history
Signed-off-by: AbhishekKr <[email protected]>
  • Loading branch information
abhishekkr committed Dec 26, 2017
1 parent 68bab3f commit c875f81
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 41 deletions.
61 changes: 21 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,49 @@
## dory

[![Go Report Card](https://goreportcard.com/badge/abhishekkr/dory)](https://goreportcard.com/report/abhishekkr/dory) [![Build Status](https://travis-ci.org/abhishekkr/dory.svg?branch=master)](https://travis-ci.org/abhishekkr/dory)
Share your secret with a fish that have short term memory.

quick try using docker [abhishekkr/dory:1.0-alpine](https://hub.docker.com/r/abhishekkr/dory/)
[![Go Report Card](https://goreportcard.com/badge/abhishekkr/dory)](https://goreportcard.com/report/abhishekkr/dory) [![Build Status](https://travis-ci.org/abhishekkr/dory.svg?branch=master)](https://travis-ci.org/abhishekkr/dory)

```
docker run -it -p8080:8080 abhishekkr/dory:latest
```
quick try using docker [abhishekkr/dory:1.2-alpine](https://hub.docker.com/r/abhishekkr/dory/)

Share your secret with a fish that have short term memory.
[quick usage guide for dory server and client](https://abhishekkr.github.io/dory/usage)

When you run `dory`, webserver by default will be available at [:8080](http://localhost:8080) and hosts [help document](http://localhost:8080/help) for quick overview.


Current Features:

> * added `/ping` api listing count of keys in cache and disk
>
> * blind list and purge of keys over `/admin/store/{cache,disk}` api using Admin Token; `just a reminder that value is not recoverable using Admin Token`
>
> * can also reach permanent (disk persisted, non-ttl) memories in Dory by providing `GET Param` as `persist=true`
* local-auth has 2 kind of datastores, non-persistent `cache` and persistent `disk`

> * both of these stores purge their entry on any fetch by default, unless asked to `keep=true` it further
>
> * provides local auth-store backed by `cache2go` and encrypted by AES crypto
> * `cache` store has extra expiry attached to it, for keys to self-delete if not accessed for TTL (default 300seconds)
>
> * allows POST, GET and DELETE for a `auth identifier path` (like `http://dory.local:8080/local-auth/:identifier`) to store, fetch and purge data
> * `disk` store persists secrets which are resumable even after service restart
>
> * successful POST of data at `auth identifier path` returns reference `X-DORY-TOKEN` mapped with this `auth identifier path`, this token need to be sent as value of this header `X-DORY-TOKEN` for GET and DELETE.
> * all secrets are stored post AES encryption with per secret unique token
>
> * created secret store have default TTL of 5minutes, custom TTL can be set as URL Param in POST request by value of `ttlsecond` in seconds
> * every secret can only be deciphered by it's token which is returned as response of posting the secret, so if token is lost... so is data in secret
>
> * first GET of secret will purge it from store, unless GET Param `keep=true` is provided
---

* How To Fetch Dependencies
> * token is also required to delete the secret by normal users
```
./go-tasks deps
```

* admin tasks

* How To Build

> following command will create a ./bin directory an create multi platform binaries there to run
> will also fetch dependencies if not done already
> * listing of all the keys against which secrets are stored
>
> default it runs at `:8080`, to run it at any other port (or IP::PORT), export environment variable `DORY_HTTP` with required listen-at value before running `dory` in that env scope.
```
./go-tasks build
```

> * purge one key, if by mistake wrong or undesired secret has been shared
>
> * purge all keys, for cleanup or in times of threat
>
> `just a reminder that value is not recoverable using Admin Token`
* How To Use LocalAuth

> [curl example](w3assets/dory.sh)
* `/ping` api listing count of keys in cache and disk

---

building docker with custom local binary

```
docker build -t abhishekkr/dory:alpha -f w3assets/Dockerfile .
```
[developer's documentation](https://abhishekkr.github.io/dory/development)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ dory-linux-amd64:
-persist
to decide datastore as cache or disk, defaults as false for cache
-task string
the kind of action dory client need to perform, supports {set,get,del,list,purge,ping}; defaults ping (default "ping")
the kind of action dory client need to perform, supports {set,get,del,list,purge,purge-one,ping}; defaults ping (default "ping")
-token string
token for secret, required when trying to Get or Delete a key
-ttl int
Expand Down

0 comments on commit c875f81

Please sign in to comment.