From 6597e0c9e7fc5f3b080676fc81806cada542b80c Mon Sep 17 00:00:00 2001 From: cisopaul Date: Tue, 9 Jul 2024 13:52:26 +1000 Subject: [PATCH 1/2] initial fixes for the deployment instructions --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2c360de..fef88ae 100644 --- a/README.md +++ b/README.md @@ -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` + +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` + +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 @@ -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: From 97a854a8725dbf1bda40aec8dbce5cb2c244bfcc Mon Sep 17 00:00:00 2001 From: cisopaul Date: Tue, 9 Jul 2024 16:39:25 +1000 Subject: [PATCH 2/2] fix backticks & spelling in PR review --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fef88ae..6c807e0 100644 --- a/README.md +++ b/README.md @@ -35,10 +35,10 @@ Make sure that you have Docker installed on your machine. You can download Docke 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` +```git clone git@github.com:cipherstash/cipherstash-proxy-playground.git +cd cipherstash-proxy-playground``` -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` +This repository includes 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` To deploy the environment run the following command from the `cipherstash-proxy-playground` directory.