diff --git a/docs/tutorials/deployment/index.mdx b/docs/tutorials/deployment/index.mdx index be78de8..a5eb7df 100644 --- a/docs/tutorials/deployment/index.mdx +++ b/docs/tutorials/deployment/index.mdx @@ -16,6 +16,16 @@ This tutorial is a community contribution and is not supported by the Open WebUI We're looking for talented individuals to create videos showcasing Open WebUI's features. If you make a video, we'll feature it at the top of our guide section! ::: + + + +### Step 1: Create a Helicone account and generate your API key + +Create a [Helicone account](https://www.helicone.ai/) and log in to generate an [API key here](https://us.helicone.ai/settings/api-keys). + +*— Make sure to generate a [write only API key](https://docs.helicone.ai/helicone-headers/helicone-auth). This ensures you only allow logging data to Helicone without read access to your private data.* + +### Step 2: Create an OpenAI account and generate your API key + + Create an OpenAI account and log into [OpenAI's Developer Portal](https://platform.openai.com/account/api-keys) to generate an API key. + +### Step 3: Run your Open WebUI application using Helicone's base URL + +To launch your first Open WebUI application, use the command from [Open WebUI docs](https://docs.openwebui.com/) and include Helicone's API BASE URL so you can query and monitor automatically. + +```bash + # Set your environment variables + export HELICONE_API_KEY= + export OPENAI_API_KEY= + + # Run Open WebUI with Helicone integration + docker run -d -p 3000:8080 \ + -e OPENAI_API_BASE_URL="https://oai.helicone.ai/v1/$HELICONE_API_KEY" \ + -e OPENAI_API_KEY="$OPENAI_API_KEY" \ + --name open-webui \ + ghcr.io/open-webui/open-webui +``` + +If you already have a Open WebUI application deployed, go to the `Admin Panel` > `Settings` > `Connections` and click on the `+` sign for "Managing OpenAI API Connections". Update the following properties: + +- Your `API Base URL` would be ``https://oai.helicone.ai/v1/`` +- The `API KEY` would be your OpenAI API key. + +![Open WebUI Helicone Setup](https://res.cloudinary.com/dacofvu8m/image/upload/v1745272273/openwebui-helicone-setup_y4ssca.gif) + +### Step 4: Make sure monitoring is working + +To make sure your integration is working, log into Helicone's dashboard and review the "Requests" tab. + +You should see the requests you have made through your Open WebUI interface already being logged into Helicone. + +![Example Helicone Trace](https://res.cloudinary.com/dacofvu8m/image/upload/v1745272747/CleanShot_2025-04-21_at_17.57.46_2x_wpkpyf.png) + +## Learn more + +For a comprehensive guide on Helicone, you can check out [Helicone's documentation here](https://docs.helicone.ai/getting-started/quick-start).