From f4716bead558b8b9bc7a05df5f8b44589c8caa57 Mon Sep 17 00:00:00 2001 From: nai-degen <44111-khanon@users.noreply.gitgud.io> Date: Sat, 8 Apr 2023 09:00:19 -0500 Subject: [PATCH] updates documentation --- README.md | 7 +++++-- src/info-page.ts | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bfa7801..97bd6b4 100644 --- a/README.md +++ b/README.md @@ -46,5 +46,8 @@ So, if you still want to share access to your key, you can use this to do so saf - Your server should automatically deploy when you add the secret, but if not you can select `Factory Reset` from that same Settings menu. ### 5. Share the link -- The Service Info screen should show the URL for your server. You can share this with anyone to safely give them access to your OpenAI API key. -- If you want to protect access to the server, add another secret with the key `PROXY_KEY` using the method as for `OPENAI_KEY`. +- The Service Info section below should show the URL for your server. You can share this with anyone to safely give them access to your OpenAI API key. +- Your friend doesn't need any OpenAI API key of their own, they just need your link. +- However, if you want to protect access to the server, you can add another secret called `PROXY_KEY`. This key will need to be passed in the Authentication header of every request to the server, just like an OpenAI API key. + +**Note:** The `keys` section in the serverinfo screen may not correctly identify keys as trial/paid/GPT-4 unless you use the more advanced configuration described in `.env.example`. diff --git a/src/info-page.ts b/src/info-page.ts index 7992884..7970792 100644 --- a/src/info-page.ts +++ b/src/info-page.ts @@ -13,7 +13,7 @@ function getInfoPageHtml(host: string) { uptime: process.uptime(), timestamp: Date.now(), baseUrl: host, - kobold: host + "/proxy/kobold", + kobold: host + "/proxy/kobold" + " (not yet implemented)", openai: host + "/proxy/openai", keys: { all: keylist.length,