This project is a language model gateway that provides an OpenAI compatible API for language models. It is built using FastAPI and GraphQL.
- Docker
- Docker Compose
- Make
To run the project locally, follow these steps:
-
Clone the repository:
git clone <repository-url> cd <repository-directory>
-
Create
docker.env
file in the root of the project based on thedocker.env.example
. Update the keys for the functionality/providers you're planning on using.AWS_CREDENTIALS_PROFILE
is the only one that is absolutely required to get going. Set this to the AWS profile you're part of e.g.,admin_dev
. -
Set up the development environment:
make devsetup
-
Start the Docker containers:
make down; make up
Just run the following commands to run OpenWebUI without OAuth:
make down; make up; make up-open-webui
Since the OpenWebUI uses Keycloak on both server side and browser side, you need to create a host mapping for keycloak
.
On Macs, this can be done by adding an entry to /etc/hosts
:
127.0.0.1 keycloak
Then run:
make down; make up; make up-open-webui-auth