updates README

This commit is contained in:
nai-degen 2023-04-09 20:21:28 -05:00 committed by nai-degen
parent bae6574926
commit 04512cb352
2 changed files with 12 additions and 2 deletions

View File

@ -11,7 +11,6 @@ pinned: false
Simple reverse proxy server for the OpenAI API.
[![Run on Repl.it](https://replit.com/badge/github/nai-degen/oai-reverse-proxy)](https://replit.com/new/github/nai-degen/oai-reverse-proxy)
## What is this?
If you have an API key you want to share with a friend, you can use this to keep your key safe while still allowing them to generate text with the API.
@ -24,6 +23,12 @@ If you still want to share access to your key, you can put it behind this proxy
## How to use
Since this is a server, you'll need to deploy it somewhere. A few options are available:
### Deploy to Huggingface Space
### Deploy to Huggingface (Recommended)
[See here for instructions on deploying to a Huggingface Space.](./docs/huggingface.md)
### Deploy to Repl.it (WIP)
Still working on this. It's a bit more technical than the Huggingface option; you can give it a shot by clicking on the button below.
[![Run on Repl.it](https://replit.com/badge/github/nai-degen/oai-reverse-proxy)](https://replit.com/new/github/nai-degen/oai-reverse-proxy)
You'll need to set your secrets in Replit similar to the Huggingface instructions above. Currently .env files don't work properly so it only uses the default configuration.

View File

@ -1,5 +1,10 @@
FROM node:18-bullseye-slim
RUN apt-get update && \
apt-get install -y git
RUN git clone https://github.com/nai-degen/oai-reverse-proxy.git /app
WORKDIR /app
COPY package*.json ./