Skip to content

Updates for the deployment instructions #11

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updates for the deployment instructions #11

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6597e0c
initial fixes for the deployment instructions
cisopaul Jul 9, 2024
97a854a
fix backticks & spelling in PR review
cisopaul Jul 9, 2024
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
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,26 @@ This is a playground for CipherStash Proxy. It is a collection of microservices
- [Simulating network conditions](#simulating-network-conditions)
- [Cleaning up](#cleaning-up)

## Getting started
## Pre-requisites

Make sure that you have Docker installed on your machine. You can download Docker from [here](https://www.docker.com/products/docker-desktop).
Configure the Proxy config file located at `config/cipherstash-proxy.toml` to your desired configuration, noting that the default configuration is already set up to work with the other services in the playground.

Once you have Docker installed, run the following command to start the playground:
## Getting started

Clone the repository into a new directory on your local machine.

`git clone git@github.com:cipherstash/cipherstash-proxy-playground.git`
`cd cipherstash-proxy-playground`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reckon these should be lines inside triple back-ticks (```) so it looks like

command 1
command 2

rather than
command 1 command 2

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good call, fixed


This repository include a pre-configured config file located at `config/cipherstash/cipherstash-proxy.toml` which defines the configuration for the CipherStash Proxy. The definition for the various Docker containers that are used in the playground can be found in `docker-compose.yml`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be "includes"?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in latest commit


To deploy the environment run the following command from the `cipherstash-proxy-playground` directory.

```bash
docker compose up
```

This will start the following services as individual containers using a shared network, and mapping the necessary ports to your local machine:
This will pull the container images from DockerHub, start the following services as individual containers using a shared network, and map the necessary ports to your local machine:

- **CipherStash Proxy** - a proxy that sits between your application and your database to monitor and secure your data
- **PostgreSQL** - a database that stores dummy data
Expand All @@ -48,6 +56,8 @@ This will start the following services as individual containers using a shared n
- **Loki** - used for log aggregation
- **Promtail** - used for log collection

It will take a few minutes for the deployment to complete. When you see ` ` the deployment has completed successfully.

### Accessing the services

Access the services at the following endpoints:
Expand Down