OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-19 18:58:41 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add tutorials

Browse Source
This commit is contained in:
Justin Hayes 2024-02-25 18:06:36 -05:00 committed by GitHub
parent 7ecbd7745d
commit f8f10ed27c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/tutorial/index.md
View File

@ -10,3 +10,43 @@ title: "📝 Tutorial"
# **Seeking Contributors!**
:::
## How to Add a New Model to LiteLLM
LiteLLM supports a variety of APIs, both OpenAI-compatible and others. To integrate a new API model, follow these instructions:
1. Go to the Settings > Models > LiteLLM model management interface.
2. In 'Simple' mode, you will only see the option to enter a **Model**.
3. For additional configuration options, click on the 'Simple' toggle to switch to 'Advanced' mode. Here you can enter:
- **Model Name**: The name of the model as you want it to appear in the models list.
- **API Base URL**: The base URL for your API provider. This field can usually be left blank unless your provider specifies a custom endpoint URL.
- **API Key**: Your unique API key. Replace with the key provided by your API provider.
- **API RPM**: The allowed requests per minute for your API. Replace with the appropriate value for your API plan.
4. After entering all the required information, click the '+' button to add the new model to LiteLLM.
For more information on the specific providers and advanced settings, consult the [LiteLLM Providers Documentation](https://litellm.vercel.app/docs/providers).
## Image Generation with AUTOMATIC1111 API
Open WebUI now supports image generation through the AUTOMATIC1111 API. To set this up, follow these steps:
### Initial Setup
1. Ensure that you have AUTOMATIC1111 installed.
2. Launch the WebUI with additional flags to enable API access:
```
./webui.sh --api --listen
```
For Docker installations, use the `--listen` flag to allow connections outside of localhost.
### Configuring Open WebUI
1. In Open WebUI, navigate to Settings > Images.
2. In the API URL field, enter the address where AUTOMATIC1111's API is accessible, following this format:
```
http://<your_automatic1111_address>:7860
```
If you're running a Docker installation of Open WebUI and AUTOMATIC1111 on the same host, replace `<your_automatic1111_address>` with `host.docker.internal`.
Please note that, as of now, only the AUTOMATIC1111 API is supported for image generation within Open WebUI.