diff --git a/README.md b/README.md index ab4f8b8..95df167 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # goose-confidential How to run goose with confidential llm backend + +Go to [PrivateMode](https://www.privatemode.ai/) and create an account and an API key. + +Then, set the environment variable `PRIVATE_MODE_API_KEY` to your API key. +You can do this in your terminal with the following command: + +```bash +export PRIVATE_MODE_API_KEY=your_api_key_here +``` +You can also set this variable in your `.env` file if you are using one. +# Example .env file +``` +PRIVATE_MODE_API_KEY=your_api_key_here +``` + +# Run the application +To run the application, you can use the following command: +```bash +git clone https://github.com/aljazceru/goose-confidential.git +cd goose-confidential +# If you have not installed Docker, please do so first. +# You can find instructions on how to install Docker at https://docs.docker.com/get-docker/ +docker compose up -d +``` + +For detailed instructions and documentation about privatemode-proxy, please refer to the [privatemode-proxy documentation](https://docs.privatemode.ai/guides/proxy-configuration) + +# Configure goose +Run the following command to configure goose to use the privatemode-proxy backend: +```bash +goose configure +``` +and follow the instructions in the terminal: +![screenshot](./screenshot.jpg) diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..63749cc --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,15 @@ +services: + privatemode-proxy: + image: ghcr.io/edgelesssys/privatemode/privatemode-proxy:latest + environment: + - PRIVATEMODE_API_KEY=${PRIVATEMODE_API_KEY:-} + - PRIVATEMODE_CACHE_MODE=${PRIVATEMODE_CACHE_MODE:-none} + - PRIVATEMODE_CACHE_SALT=${PRIVATEMODE_CACHE_SALT:-} + entrypoint: ["/bin/privatemode-proxy"] + command: [ + "--apiKey=${PRIVATEMODE_API_KEY}", + "--port=8080" + ] + ports: + - "28082:8080" + restart: unless-stopped diff --git a/screenshot.jpg b/screenshot.jpg new file mode 100644 index 0000000..4d3fed1 Binary files /dev/null and b/screenshot.jpg differ