Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alovak committed Oct 16, 2024
1 parent b2391fd commit b10aac5
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,16 @@ Links:
* [Documentation](https://docs.vaulty.co)
* [Cookbooks](https://docs.vaulty.co/cookbooks/intro)

## Prerequisites
## Installation

For the quick start the only thing you need is [Docker](https://docs.docker.com/install/).

Or you can install it using Go:

```bash
go install github.com/vaulty/vaulty/cmd/vaulty
```

## Try it now!

Create a directory for experiments with Vaulty. In the directory, let's create simple routes.json file with transformation rule:
Expand Down Expand Up @@ -53,12 +59,18 @@ Create a directory for experiments with Vaulty. In the directory, let's create s

In short, Vaulty will encrypt `card.number` element of JSON body of all POST requests with /post path and then send it [http://postman-echo.com](http://postman-echo.com) (postman-echo is echo server; it will return all data it receives).

Now, let's run Vaulty as a proxy:
Now, let's run Vaulty as a proxy using Docker:

```bash
docker run -p 8080:8080 -v ${PWD}:/.vaulty vaulty/vaulty
```

or using installed Go binary:

```bash
vaulty proxy
```

You should see something like this:

```
Expand Down

0 comments on commit b10aac5

Please sign in to comment.