Skip to content

Update getting started tutorial #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove notes around needing to upload an empty dataset
  • Loading branch information
fimac committed Nov 13, 2024
commit abd58db8d4a533dc785a21ba90cfa95ce43148f7
7 changes: 6 additions & 1 deletion docs/tutorials/GETTINGSTARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,12 @@ source .envrc
docker compose up
```

8. Check PostgreSQL and the Proxy are running:
This will:

- spin up a docker container for the CipherStash Proxy and Postgres
- install EQL

8. Check Postgres and the Proxy are running:

```shell
docker ps
Expand Down
15 changes: 5 additions & 10 deletions docs/tutorials/PROXY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The CipherStash Proxy is a lightweight proxy that can be used to encrypt and dec
## Table of Contents

- [Getting Started](#getting-started)
- [Uploading an empty dataset](#uploading-an-empty-dataset)
- [Create a dataset and client](#create-a-dataset-and-client)
- [Configuring CipherStash Proxy](#configuring-cipherstash-proxy)
- [Running the Proxy](#running-the-proxy)
- [Using the Proxy](#using-the-proxy)
Expand All @@ -19,19 +19,14 @@ To get started, you'll need to sign up for a free account at [https://dashboard.

Once you've signed up, you can create an access key from your default workspace.

## Uploading an empty dataset
## Create a dataset and client

Before you can start using the proxy, you'll need to upload an empty dataset. You can do this using the [CipherStash CLI](https://cipherstash.com/docs/reference/cli)
Before you can start using the proxy, you'll need to create a dataset and client.

You can do this using the [CipherStash CLI](https://cipherstash.com/docs/reference/cli)

1. [Create a dataset.](https://cipherstash.com/docs/how-to/creating-datasets)
1. [Create a client key for cryptographic operations.](https://cipherstash.com/docs/how-to/creating-clients)
1. Upload an empty dataset:

```bash
stash datasets config upload --file dataset.yml --client-id client_id --client-key client_key
```

> Note: CipherStash Proxy will be unable to initialize unless an empty dataset is uploaded. You will see the error `ZeroKMSError("Failed to send request: NotFound: Server returned a not found response: Status: 404 Not Found`

## Configuring CipherStash Proxy

Expand Down