From 58ebc3902f07438105ab5be738c94564519504df Mon Sep 17 00:00:00 2001 From: Sam Becker Date: Thu, 21 Mar 2024 22:50:57 -0500 Subject: [PATCH] Update README text --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2349380e..3a87de40 100644 --- a/README.md +++ b/README.md @@ -72,17 +72,19 @@ Installation _⚠️ READ BEFORE PROCEEDING_ -> _Usage of this feature will result in fees from OpenAI. When enabling AI text generation, follow all recommended mitigations in order to avoid unexpected charges and attacks. Make sure your OpenAI secret key is not prefixed with NEXT_PUBLIC._ +> _Usage of this feature will result in fees from OpenAI. When enabling AI text generation, follow all recommended mitigations in order to avoid unexpected charges and attacks. Make sure your OpenAI secret key environment variable is not prefixed with NEXT_PUBLIC._ 1. Setup OpenAI - If you don't already have one, create an [OpenAI](https://openai.com) account - - Generate an API key and store as `OPENAI_SECRET_KEY` + - Generate an API key and store in environment variable `OPENAI_SECRET_KEY` - Setup usage limits to avoid unexpected charges (_recommended_) 2. Add rate limiting (_recommended_) - As an additional precaution, create a [Vercel KV](https://vercel.com/docs/storage/vercel-kv/quickstart#create-a-kv-database) store and link it to your project in order to enable rate limiting ### 8. Optional configuration +Application behavior can be changed by configuring the following environment variables: + - `NEXT_PUBLIC_PRO_MODE = 1` enables higher quality image storage for jpgs (will result in increased storage usage) - `NEXT_PUBLIC_BLUR_DISABLED = 1` prevents image blur data being stored and displayed (potentially useful for limiting Postgres usage) - `NEXT_PUBLIC_GEO_PRIVACY = 1` disables collection/display of location-based data