diff --git a/docs/tutorial/_category_.json b/docs/tutorial/_category_.json new file mode 100644 index 0000000..00ffbc6 --- /dev/null +++ b/docs/tutorial/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "📝 Tutorial", + "position": 3, + "link": { + "type": "generated-index" + } +} \ No newline at end of file diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md deleted file mode 100644 index a94a836..0000000 --- a/docs/tutorial/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar_position: 3 -title: "📝 Tutorial" ---- - -# 📝 Tutorial - -:::info - -# **Seeking Contributors!** - -::: diff --git a/docs/tutorial/litellm.md b/docs/tutorial/litellm.md index 80c4ed3..df160bf 100644 --- a/docs/tutorial/litellm.md +++ b/docs/tutorial/litellm.md @@ -2,13 +2,13 @@ ## Initial Setup -To allow editing of your [LiteLLM](https://litellm.vercel.app/docs/proxy/configs#quick-start) `config.yaml` file, use `-v /path/to/litellm/config.yaml:/app/backend/data/litellm/config.yaml` to bind-bound it with your `docker run` command: +To allow editing of your [LiteLLM](https://litellm.vercel.app/docs/proxy/configs#quick-start) `config.yaml` file, use `-v /path/to/litellm/config.yaml:/app/backend/data/litellm/config.yaml` to bind-mount it with your `docker run` command: ```bash docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data -v /path/to/litellm/config.yaml:/app/backend/data/litellm/config.yaml --name open-webui --restart always ghcr.io/open-webui/open-webui:main ``` -*Note: `config.yaml` does not need to exist on the host before running for the first time.* +_Note: `config.yaml` does not need to exist on the host before running for the first time._ ## Configuring Open WebUI @@ -17,6 +17,7 @@ docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open- 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. @@ -26,10 +27,10 @@ docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open- ## Examples -*Ollama API (from inside Docker):* +_Ollama API (from inside Docker):_ ![LiteLLM Config Ollama](/img/tutorial_litellm_ollama.png) -*Gemini API (MakerSuite/AI Studio):* +_Gemini API (MakerSuite/AI Studio):_ ![LiteLLM Config Gemini](/img/tutorial_litellm_gemini.png) Advanced configuration options not covered in the settings interface can be edited in the `config.yaml` file manually. For more information on the specific providers and advanced settings, consult the [LiteLLM Providers Documentation](https://litellm.vercel.app/docs/providers).