diff --git a/docs/README.md b/docs/README.md index f3817d3c1..bd531aea8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,13 +1,19 @@ # Documentation -### Getting Started +### Getting started + * [Quickstart](https://docs.ollama.com/quickstart) +* [Ollama's cloud](https://docs.ollama.com/cloud) +* [Run Ollama locally](https://docs.ollama.com/local) * [Examples](./examples.md) + +### Local + +* [macOS](https://docs.ollama.com/macos) +* [Linux](https://docs.ollama.com/linux) +* [Windows](https://docs.ollama.com/windows) +* [Docker](https://docs.ollama.com/docker) * [Importing models](https://docs.ollama.com/import) -* [MacOS Documentation](https://docs.ollama.com/macos) -* [Linux Documentation](https://docs.ollama.com/linux) -* [Windows Documentation](https://docs.ollama.com/windows) -* [Docker Documentation](https://docs.ollama.com/docker) ### Reference @@ -19,5 +25,6 @@ ### Resources * [Troubleshooting Guide](https://docs.ollama.com/troubleshooting) -* [FAQ](https://docs.ollama.com/faq) +* [Local FAQ](https://docs.ollama.com/faq) +* [Cloud FAQ](https://docs.ollama.com/cloud/faq) * [Development guide](./development.md) diff --git a/docs/api/introduction.mdx b/docs/api/introduction.mdx index 2d7a73d4b..640e815d9 100644 --- a/docs/api/introduction.mdx +++ b/docs/api/introduction.mdx @@ -1,8 +1,9 @@ --- title: Introduction +description: Use the Ollama API locally or with Ollama's cloud models. --- -Use Ollama's API to build applications with cloud or local models. +Use Ollama's API to build applications with local or cloud models. ## Get started @@ -22,7 +23,7 @@ The Anthropic client appends `/v1/messages` to its base URL. Cloud requests need an API key. Local requests do not. To use cloud models through your local server, [sign in to Ollama](/api/authentication#signing-in). -Creating or deleting models requires a local Ollama server. [System One](/capabilities/decision) also requires a local server and is not yet available on Ollama Cloud. For supported API features, see [OpenAI compatibility](/api/openai-compatibility) and [Anthropic compatibility](/api/anthropic-compatibility). +Creating or deleting models requires a local Ollama server. [System One](/capabilities/decision) also requires a local server and is not yet available on cloud. For supported API features, see [OpenAI compatibility](/api/openai-compatibility) and [Anthropic compatibility](/api/anthropic-compatibility). ## Ollama API example diff --git a/docs/capabilities/structured-outputs.mdx b/docs/capabilities/structured-outputs.mdx index c570a12f9..5a2df685b 100644 --- a/docs/capabilities/structured-outputs.mdx +++ b/docs/capabilities/structured-outputs.mdx @@ -3,7 +3,7 @@ title: Structured Outputs --- - Ollama's Cloud currently does not support structured outputs. + Ollama's cloud currently does not support structured outputs. Structured outputs let you enforce a JSON schema on model responses so you can reliably extract structured data, describe images, or keep every reply consistent. diff --git a/docs/capabilities/thinking.mdx b/docs/capabilities/thinking.mdx index b357ccd86..2a8dde8f8 100644 --- a/docs/capabilities/thinking.mdx +++ b/docs/capabilities/thinking.mdx @@ -43,7 +43,7 @@ Set the `think` field on a chat or generate request: - `null`: use the model default. - A string: select a supported level from `thinking.values`. Use the exact value from `/api/show`. Numbers are not supported. -If the model resolves named levels from `/api/show` metadata, Ollama applies supported names exactly. Unsupported names use the model default. +If the model resolves named levels from `/api/show` metadata, Ollama applies supported names exactly. Unsupported names use the model default. The reasoning output and answer use separate fields. Chat returns `message.thinking` and `message.content`. Generate returns `thinking` and `response`. diff --git a/docs/cloud.mdx b/docs/cloud.mdx index d0268f44d..a9c06d26d 100644 --- a/docs/cloud.mdx +++ b/docs/cloud.mdx @@ -1,92 +1,47 @@ --- -title: Cloud -sidebarTitle: Cloud +title: Ollama's cloud +sidebarTitle: Overview +description: Choose how to run Ollama's cloud models through the Ollama CLI, a local API, or the direct cloud API. --- -Run models in Ollama's cloud from your apps or terminal. No model or app download required. +Ollama's cloud runs larger models without requiring a powerful GPU. Cloud models support the same capabilities as local models, but inference runs on Ollama's cloud service. -## API Key +## Choose how to connect -Create an [API key](https://ollama.com/settings/keys), then set it in Bash or Zsh: + + + Use the Ollama CLI, Python or JavaScript library, or your local Ollama API. Cloud model names use the `:cloud` suffix. + -```shell -export OLLAMA_API_KEY="your_api_key" -``` + + Send authenticated requests to `https://ollama.com/api` without installing Ollama. + + -Send a request from the same terminal: +Both options require an Ollama account. Browse the available models in the [cloud model library](https://ollama.com/search?c=cloud). -```shell -curl https://ollama.com/api/chat \ - -H "Authorization: Bearer $OLLAMA_API_KEY" \ - -H "Content-Type: application/json" \ - -d '{ - "model": "gemma4:31b", - "messages": [ - { - "role": "user", - "content": "Say hello in one sentence." - } - ], - "stream": false - }' -``` +## Cloud models -Read the answer from `message.content`. Keep your API key out of browser code and source control. +Follow [Use Cloud models from Ollama](/cloud/models) to run a `:cloud` model from the CLI, official libraries, or the local Ollama API. -You can also use [OpenAI](/api/openai-compatibility) or [Anthropic](/api/anthropic-compatibility) clients. Each supports a subset of the original API. No Ollama installation is required. +## Cloud API access -## Ollama App or CLI +Follow the [Cloud API guide](/cloud/api) to call `https://ollama.com/api` directly with an API key. -[Download Ollama](https://ollama.com/download). Open the app, or run: +## Local only -```shell -ollama -``` +Use [Local](/local) when you want inference to run on your own hardware. Ollama can also run in [local-only mode](/faq#how-do-i-disable-ollama-cloud-features) with Cloud features disabled. -Follow the setup prompts and sign in to use cloud models. +## Retirements -On macOS, open **Apps** and connect Claude or ChatGPT. For coding agents, run a launch command: - - - -```shell Claude Code -ollama launch claude -``` - -```shell Codex CLI -ollama launch codex -``` - -```shell OpenCode -ollama launch opencode -``` - - - -For more integrations, open the Ollama app or run `ollama` in your terminal. - -Ollama handles sign-in for connected apps. See the [quickstart](/quickstart) for setup. - -## Models - -Browse [cloud models](https://ollama.com/search?c=cloud), or list them with the API: - -```shell -curl https://ollama.com/api/tags -``` - -For API requests to ollama.com, use the name returned by this list, such as `gemma4:31b`. In the Ollama app or CLI, use `gemma4:cloud`. Cloud models do not need to be downloaded. +Cloud models may be deprecated as newer models become available. See [Cloud model lifecycle](/cloud/model-lifecycle) for upcoming and past retirements. ## Usage Check your [usage](https://ollama.com/settings/usage) or compare [plans](https://ollama.com/pricing). -## Retirements - -[Usage settings](https://ollama.com/settings) show upcoming retirements for models you've recently used. Switch models before the retirement date. Downloaded local models are not affected. - ## Data handling -Ollama processes cloud prompts and responses to answer your requests. We do not use them to train models. Read the [Privacy Policy](https://ollama.com/privacy) for details. +Ollama processes Cloud prompts and responses to answer your requests. We do not use them to train models. Read the [Privacy Policy](https://ollama.com/privacy) for details. -To use only local models, [disable cloud features](/faq#how-do-i-disable-ollama-cloud-features). +For questions about Cloud accounts, privacy, authentication, and requests, see the [Cloud FAQ](/cloud/faq). diff --git a/docs/cloud/api.mdx b/docs/cloud/api.mdx new file mode 100644 index 000000000..4aa232d59 --- /dev/null +++ b/docs/cloud/api.mdx @@ -0,0 +1,97 @@ +--- +title: Cloud API +description: Authenticate and call Ollama's cloud API directly at https://ollama.com/api. +--- + +Call cloud models directly through `https://ollama.com/api`. In this mode, `ollama.com` is the Ollama host and a local Ollama installation is not required. + +## Authentication + +Create an [API key](https://ollama.com/settings/keys), then set it as an environment variable: + +```shell +export OLLAMA_API_KEY=your_api_key +``` + +Send the key as a bearer token in the `Authorization` header with every request. + +## List models + +```shell +curl https://ollama.com/api/tags \ + -H "Authorization: Bearer $OLLAMA_API_KEY" +``` + +## Generate a response + + + + +```shell +curl https://ollama.com/api/chat \ + -H "Authorization: Bearer $OLLAMA_API_KEY" \ + -d '{ + "model": "gpt-oss:120b", + "messages": [{"role": "user", "content": "Why is the sky blue?"}], + "stream": false + }' +``` + + + + +Install the [Ollama Python library](https://github.com/ollama/ollama-python): + +```shell +pip install ollama +``` + +```python +import os +from ollama import Client + +client = Client( + host="https://ollama.com", + headers={"Authorization": "Bearer " + os.environ["OLLAMA_API_KEY"]}, +) + +messages = [{"role": "user", "content": "Why is the sky blue?"}] + +for part in client.chat("gpt-oss:120b", messages=messages, stream=True): + print(part["message"]["content"], end="", flush=True) +``` + + + + +Install the [Ollama JavaScript library](https://github.com/ollama/ollama-js): + +```shell +npm i ollama +``` + +```typescript +import { Ollama } from "ollama"; + +const ollama = new Ollama({ + host: "https://ollama.com", + headers: { + Authorization: "Bearer " + process.env.OLLAMA_API_KEY, + }, +}); + +const response = await ollama.chat({ + model: "gpt-oss:120b", + messages: [{ role: "user", content: "Explain quantum computing" }], + stream: true, +}); + +for await (const part of response) { + process.stdout.write(part.message.content); +} +``` + + + + +For endpoint schemas and response fields, use the [API Reference](/api/introduction). diff --git a/docs/cloud/faq.mdx b/docs/cloud/faq.mdx new file mode 100644 index 000000000..2c2ca395d --- /dev/null +++ b/docs/cloud/faq.mdx @@ -0,0 +1,63 @@ +--- +title: Cloud FAQ +sidebarTitle: FAQ +description: Frequently asked questions about Ollama's cloud models, accounts, authentication, privacy, and requests. +--- + +For questions about installation, hardware, and the local Ollama server, see the [Local FAQ](/faq). + +## Does Ollama send my prompts and answers back to ollama.com? + +Ollama runs locally. We don't see your prompts or data when you run local models. + +When you use Cloud models, Ollama processes your prompts and responses to provide the service but does not store or log that content and never trains on it. Ollama collects basic account information and limited usage metadata that does not include prompt or response content. Ollama does not sell your data, and you can delete your account at any time. + +To prevent a local Ollama installation from using Cloud models and web search, enable [local-only mode](/faq#how-do-i-disable-ollama-cloud-features). + +## How do I manage the maximum number of requests the Ollama server can queue? + +When you access Cloud models through a local Ollama server, requests can queue locally while the server is busy. If the queue is full, the server responds with a `503` overloaded error. + +Set `OLLAMA_MAX_QUEUE` before starting the local server to change the maximum number of queued requests: + +```shell +OLLAMA_MAX_QUEUE=1024 ollama serve +``` + +See [How do I configure Ollama server?](/faq#how-do-i-configure-ollama-server) for operating-system-specific instructions for setting environment variables. + +## What is the difference between an API key and my Ollama Public Key? + +An **API key** authenticates a program that calls `https://ollama.com/api` directly. Create and manage API keys in [Ollama settings](https://ollama.com/settings/keys). See [Cloud API authentication](/cloud/api#authentication) for an example. + +Your **Ollama Public Key** identifies a local Ollama installation to ollama.com. It is used when you sign in locally to run Cloud models, push models, or pull private models. + +## Where can I find my Ollama Public Key? + +The Ollama Public Key is the public part of the key pair that lets your local Ollama instance communicate with [ollama.com](https://ollama.com). + +You need it to: + +- Push models to Ollama +- Pull private models to your machine +- Run models hosted in Ollama's cloud through your local Ollama installation + +### Add the key to your account + +Sign in from the Settings page in the macOS or Windows app, or sign in from the CLI: + +```shell +ollama signin +``` + +You can also copy and paste the public key on the [Ollama Keys](https://ollama.com/settings/keys) page. + +### Find the key on disk + +| Operating system | Path to `id_ed25519.pub` | +| --- | --- | +| macOS | `~/.ollama/id_ed25519.pub` | +| Linux | `/usr/share/ollama/.ollama/id_ed25519.pub` | +| Windows | `C:\Users\\.ollama\id_ed25519.pub` | + +Replace `` with your Windows user name. diff --git a/docs/cloud/model-lifecycle.mdx b/docs/cloud/model-lifecycle.mdx new file mode 100644 index 000000000..bbeeb1ebe --- /dev/null +++ b/docs/cloud/model-lifecycle.mdx @@ -0,0 +1,71 @@ +--- +title: Cloud model lifecycle +description: Review upcoming and past retirements of Ollama's cloud models and recommended replacements. +--- + +Ollama occasionally deprecates and retires older Cloud models as newer models become available. Tools and applications that depend on a retired model must be updated to use another model. + +Impacted users are notified before a model is retired. Cloud model retirement does not affect local models. + +## Upcoming retirements + +No Cloud model retirements are currently scheduled. + +## Past retirements + + + + | Model | Recommended alternative | + | --- | --- | + | `qwen3.5:397b` | `glm-5.3` | + | `glm-5.1` | `glm-5.2` | + | `deepseek-v4-flash:0731` | `deepseek-v4.1-flash` | + + + + | Model | Recommended alternative | + | --- | --- | + | `minimax-m2.5` | `minimax-m2.7` | + | `kimi-k2.5` | `kimi-k2.6` | + + + + | Model | Recommended alternative | + | --- | --- | + | `deepseek-v3.1:671b` | `deepseek-v4-flash` | + | `deepseek-v3.2` | `deepseek-v4-flash` | + | `devstral-2:123b` | `mistral-large-3:675b` | + | `devstral-small-2:24b` | | + | `ministral-3:14b` | | + | `ministral-3:3b` | | + | `ministral-3:8b` | | + | `gemini-3-flash-preview` | `minimax-m3` | + | `gemma3:12b` | `gemma4:31b` | + | `gemma3:27b` | `gemma4:31b` | + | `gemma3:4b` | `gemma4:31b` | + | `glm-4.7` | `glm-5.2` | + | `glm-5` | `glm-5.2` | + | `minimax-m2.1` | `minimax-m3` | + | `qwen3-coder-next` | `qwen3.5:397b` | + | `qwen3-coder:480b` | `qwen3.5:397b` | + + + + | Model | Recommended alternative | + | --- | --- | + | `rnj-1:8b` | | + + + + | Model | Recommended alternative | + | --- | --- | + | `kimi-k2-thinking` | `kimi-k2.6` | + | `kimi-k2:1t` | `kimi-k2.6` | + | `minimax-m2` | `minimax-m3` | + | `glm-4.6` | `glm-5.1` | + | `qwen3-next:80b` | `qwen3.5` | + | `qwen3-vl:235b` | `qwen3.5` | + | `qwen3-vl:235b-instruct` | `qwen3.5` | + | `cogito-2.1:671b` | `deepseek-v4-flash` | + + diff --git a/docs/cloud/models.mdx b/docs/cloud/models.mdx new file mode 100644 index 000000000..8f2f19081 --- /dev/null +++ b/docs/cloud/models.mdx @@ -0,0 +1,94 @@ +--- +title: Use Cloud models from Ollama +sidebarTitle: Cloud models +description: Run Ollama's cloud models from the CLI, the local Ollama API, or the official Python and JavaScript libraries. +--- + +Cloud models are automatically offloaded to Ollama's cloud while remaining available to local tools and integrations through Ollama. + +## Sign in + +Cloud models require an account on [ollama.com](https://ollama.com). Sign in or create an account from the CLI: + +```shell +ollama signin +``` + +Browse supported models in the [cloud model library](https://ollama.com/search?c=cloud). + +## Run a Cloud model + + + + +```shell +ollama run gpt-oss:120b-cloud +``` + + + + +Pull the Cloud model, then install the [Ollama Python library](https://github.com/ollama/ollama-python): + +```shell +ollama pull gpt-oss:120b-cloud +pip install ollama +``` + +```python +from ollama import Client + +client = Client() + +messages = [{"role": "user", "content": "Why is the sky blue?"}] + +for part in client.chat("gpt-oss:120b-cloud", messages=messages, stream=True): + print(part["message"]["content"], end="", flush=True) +``` + + + + +Pull the Cloud model, then install the [Ollama JavaScript library](https://github.com/ollama/ollama-js): + +```shell +ollama pull gpt-oss:120b-cloud +npm i ollama +``` + +```typescript +import { Ollama } from "ollama"; + +const ollama = new Ollama(); +const response = await ollama.chat({ + model: "gpt-oss:120b-cloud", + messages: [{ role: "user", content: "Explain quantum computing" }], + stream: true, +}); + +for await (const part of response) { + process.stdout.write(part.message.content); +} +``` + + + + +Pull the Cloud model, then call it through the local Ollama API: + +```shell +ollama pull gpt-oss:120b-cloud +``` + +```shell +curl http://localhost:11434/api/chat -d '{ + "model": "gpt-oss:120b-cloud", + "messages": [{"role": "user", "content": "Why is the sky blue?"}], + "stream": false +}' +``` + + + + +To use Cloud without a local Ollama installation, call the [Cloud API directly](/cloud/api). diff --git a/docs/context-length.mdx b/docs/context-length.mdx index abc2133b8..2d03c94f8 100644 --- a/docs/context-length.mdx +++ b/docs/context-length.mdx @@ -22,7 +22,7 @@ Cloud models are set to their maximum context length by default. ### App Change the slider in the Ollama app under settings to your desired context length. -![Context length in Ollama app](./images/ollama-settings.png) +![Context length in Ollama app](/images/ollama-settings.png) ### CLI If editing the context length for Ollama is not possible, the context length can also be updated when serving Ollama. diff --git a/docs/docs.json b/docs/docs.json index ed96b7167..5e4a0bbdb 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -107,6 +107,90 @@ { "source": "/integrations/poolside", "destination": "/integrations/pool" + }, + { + "source": "/guide/quickstart", + "destination": "/quickstart" + }, + { + "source": "/guide/capabilities/streaming", + "destination": "/capabilities/streaming" + }, + { + "source": "/guide/capabilities/thinking", + "destination": "/capabilities/thinking" + }, + { + "source": "/guide/capabilities/structured-outputs", + "destination": "/capabilities/structured-outputs" + }, + { + "source": "/guide/capabilities/decision", + "destination": "/capabilities/decision" + }, + { + "source": "/guide/capabilities/vision", + "destination": "/capabilities/vision" + }, + { + "source": "/guide/capabilities/embeddings", + "destination": "/capabilities/embeddings" + }, + { + "source": "/guide/capabilities/tool-calling", + "destination": "/capabilities/tool-calling" + }, + { + "source": "/guide/capabilities/web-search", + "destination": "/capabilities/web-search" + }, + { + "source": "/local/cli", + "destination": "/cli" + }, + { + "source": "/local/context-length", + "destination": "/context-length" + }, + { + "source": "/local/macos", + "destination": "/macos" + }, + { + "source": "/local/linux", + "destination": "/linux" + }, + { + "source": "/local/windows", + "destination": "/windows" + }, + { + "source": "/local/docker", + "destination": "/docker" + }, + { + "source": "/local/import", + "destination": "/import" + }, + { + "source": "/local/modelfile", + "destination": "/modelfile" + }, + { + "source": "/local/gpu", + "destination": "/gpu" + }, + { + "source": "/local/troubleshooting", + "destination": "/troubleshooting" + }, + { + "source": "/local/faq", + "destination": "/faq" + }, + { + "source": "/local/template", + "destination": "/template" } ], "navigation": { @@ -118,8 +202,7 @@ "group": "Get started", "pages": [ "index", - "quickstart", - "/cloud" + "quickstart" ] }, { @@ -134,21 +217,98 @@ "/capabilities/tool-calling", "/capabilities/web-search" ] + } + ] + }, + { + "tab": "API Reference", + "openapi": "/openapi.yaml", + "groups": [ + { + "group": "API Reference", + "pages": [ + "/api/introduction", + "/api/authentication", + "/api/streaming", + "/api/usage", + "/api/errors", + "/api/openai-compatibility", + "/api/anthropic-compatibility" + ] }, { - "group": "More information", + "group": "Endpoints", + "pages": [ + "POST /api/generate", + "POST /api/chat", + "POST /api/embed", + "POST /v1/systemone", + "GET /api/tags", + "GET /api/ps", + "POST /api/show", + "POST /api/create", + "POST /api/copy", + "POST /api/pull", + "POST /api/push", + "DELETE /api/delete", + "GET /api/version" + ] + } + ] + }, + { + "tab": "Local", + "groups": [ + { + "group": "Get started", + "pages": [ + "/local/index", + "/macos", + "/linux", + "/windows", + "/docker" + ] + }, + { + "group": "Run and configure", "pages": [ "/cli", - "/modelfile", - "/context-length", - "/linux", - "/macos", - "/windows", - "/docker", + "/context-length" + ] + }, + { + "group": "Customize models", + "pages": [ "/import", - "/faq", + "/modelfile" + ] + }, + { + "group": "Hardware and support", + "pages": [ "/gpu", - "/troubleshooting" + "/troubleshooting", + "/faq" + ] + } + ] + }, + { + "tab": "Cloud", + "groups": [ + { + "group": "Get started", + "pages": [ + "/cloud", + "/cloud/models", + "/cloud/api" + ] + }, + { + "group": "Operations", + "pages": [ + "/cloud/model-lifecycle", + "/cloud/faq" ] } ] @@ -227,45 +387,7 @@ ] } ] - }, - { - "tab": "API Reference", - "openapi": "/openapi.yaml", - "groups": [ - { - "group": "API Reference", - "pages": [ - "/api/introduction", - "/api/authentication", - "/api/streaming", - "/api/usage", - "/api/errors", - "/api/openai-compatibility", - "/api/anthropic-compatibility" - ] - }, - { - "group": "Endpoints", - "pages": [ - "POST /api/generate", - "POST /api/chat", - "POST /api/embed", - "POST /v1/systemone", - "GET /api/tags", - "GET /api/ps", - "POST /api/show", - "POST /api/create", - "POST /api/copy", - "POST /api/pull", - "POST /api/push", - "DELETE /api/delete", - "GET /api/version", - "/api/cloud-usage", - "/api/balance" - ] - } - ] } ] } -} +} \ No newline at end of file diff --git a/docs/faq.mdx b/docs/faq.mdx index c2f3b4f57..4531b9f7a 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -1,7 +1,11 @@ --- -title: FAQ +title: Local FAQ +sidebarTitle: FAQ +description: Frequently asked questions about installing, configuring, and running Ollama locally. --- +For questions about accounts, authentication, and hosted models, see the [Cloud FAQ](/cloud/faq). + ## How can I upgrade Ollama? Ollama on macOS and Windows will automatically download updates. Click on the taskbar or menubar item and then click "Restart to update" to apply the update. Updates can also be installed by downloading the latest version [manually](https://ollama.com/download/). @@ -156,11 +160,7 @@ docker build -t ollama-with-ca . docker run -d -e HTTPS_PROXY=https://my.proxy.example.com -p 11434:11434 ollama-with-ca ``` -## Does Ollama send my prompts and answers back to ollama.com? - -Ollama runs locally. We don't see your prompts or data when you run locally. When using cloud-hosted models, we process your prompts and responses to provide the service but do not store or log that content and never train on it. We collect basic account info and limited usage metadata to provide the service that does not include prompt or response content. We don't sell your data. You can delete your account anytime. - -## How do I disable Ollama Cloud features? +## How do I disable Ollama's cloud features? {#how-do-i-disable-ollama-cloud-features} Ollama can run in local only mode by disabling Ollama's cloud features. By turning off Ollama's cloud features, you will lose the ability to use Ollama's cloud models and web search. @@ -248,7 +248,7 @@ Refer to the section [above](#how-do-i-configure-ollama-server) for how to set e ## How can I use Ollama in Visual Studio Code? -Install the [Ollama extension](https://marketplace.visualstudio.com/items?itemName=Ollama.ollama) to use Ollama models in VS Code Chat. See the [VS Code integration guide](./integrations/vscode.mdx) for setup and troubleshooting. +Install the [Ollama extension](https://marketplace.visualstudio.com/items?itemName=Ollama.ollama) to use Ollama models in VS Code Chat. See the [VS Code integration guide](/integrations/vscode) for setup and troubleshooting. ## How do I use Ollama with GPU acceleration in Docker? @@ -317,10 +317,6 @@ Alternatively, you can change the amount of time all models are loaded into memo The `keep_alive` API parameter with the `/api/generate` and `/api/chat` API endpoints will override the `OLLAMA_KEEP_ALIVE` setting. -## How do I manage the maximum number of requests the Ollama server can queue? - -If too many requests are sent to the server, it will respond with a 503 error indicating the server is overloaded. You can adjust how many requests may be queued by setting `OLLAMA_MAX_QUEUE`. - ## How does Ollama handle concurrent requests? Ollama supports two levels of concurrent processing. If your system has sufficient available memory (system memory when using CPU inference, or VRAM for GPU inference) then multiple models can be loaded at the same time. For a given model, if there is sufficient available memory when the model is loaded, it is configured to allow parallel request processing. @@ -368,40 +364,6 @@ How much the cache quantization impacts the model's response quality will depend You may need to experiment with different quantization types to find the best balance between memory usage and quality. -## Where can I find my Ollama Public Key? - -Your **Ollama Public Key** is the public part of the key pair that lets your local Ollama instance talk to [ollama.com](https://ollama.com). - -You'll need it to: -* Push models to Ollama -* Pull private models from Ollama to your machine -* Run models hosted in [Ollama Cloud](https://ollama.com/cloud) - -### How to Add the Key - -* **Sign-in via the Settings page** in the **Mac** and **Windows App** - -* **Sign‑in via CLI** - -```shell -ollama signin -``` - -* **Manually copy & paste** the key on the **Ollama Keys** page: -[https://ollama.com/settings/keys](https://ollama.com/settings/keys) - -### Where the Ollama Public Key lives - -| OS | Path to `id_ed25519.pub` | -| :- | :- | -| macOS | `~/.ollama/id_ed25519.pub` | -| Linux | `/usr/share/ollama/.ollama/id_ed25519.pub` | -| Windows | `C:\Users\\.ollama\id_ed25519.pub` | - - - Replace <username> with your actual Windows user name. - - ## How can I stop Ollama from starting when I login to my computer? Ollama for Windows and macOS register as a login item during installation. You can disable this if you prefer not to have Ollama automatically start. Ollama will respect this setting across upgrades, unless you uninstall the application. diff --git a/docs/gpu.mdx b/docs/gpu.mdx index e0e141442..97ecf3f66 100644 --- a/docs/gpu.mdx +++ b/docs/gpu.mdx @@ -35,7 +35,7 @@ Check your compute compatibility to see if your card is supported: | 5.0 | GeForce GTX | `GTX 750 Ti` `GTX 750` `NVS 810` | | | Quadro | `K2200` `K1200` `K620` `M1200` `M520` `M5000M` `M4000M` `M3000M` `M2000M` `M1000M` `K620M` `M600M` `M500M` | -For building locally to support older GPUs, see [development](./development.md). +For building locally to support older GPUs, see [development](/development). ### GPU Selection diff --git a/docs/index.mdx b/docs/index.mdx index 211d051c6..c631bcfe1 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -1,6 +1,7 @@ --- title: Ollama documentation sidebarTitle: Welcome +description: Learn what Ollama can do, choose cloud or local models, and find the right guide, integration, or API reference. --- Use open models in your desktop apps and coding agents, or build them into your application. @@ -14,27 +15,66 @@ Use open models in your desktop apps and coding agents, or build them into your -## Explore models +## Choose where models run -Choose cloud models or run models on your computer. +Cloud and local models use the same Ollama tools and API shapes. The main difference is where inference runs. - - Run models without a local GPU. + + Run larger models without managing local compute, either from Ollama or through the Cloud API. - - Download Ollama and run a model on your computer. + + + Install Ollama and run models on macOS, Windows, Linux, or Docker. Browse the [model library](https://ollama.com/search) for coding, vision, embeddings, and reasoning models. +## What you can build + +Ollama supports [streaming](/capabilities/streaming), [tool calling](/capabilities/tool-calling), [structured outputs](/capabilities/structured-outputs), [decision models](/capabilities/decision), [vision](/capabilities/vision), [embeddings](/capabilities/embeddings), [thinking](/capabilities/thinking), and [web search](/capabilities/web-search). + ## Documentation -- [Integrations](/integrations) — connect an app, editor, or agent. -- [API reference](/api/introduction) — use Ollama's API or compatible OpenAI and Anthropic clients. -- [Python library](https://github.com/ollama/ollama-python) and [JavaScript library](https://github.com/ollama/ollama-js) — use Ollama from your application. + + + Connect Ollama to an app, editor, or agent. + + + + Compare local and cloud base URLs, then send your first request. + + + + Find models for chat, coding, vision, embeddings, and reasoning. + + + + Use Ollama from Python. + + + + Use Ollama from JavaScript or TypeScript. + + ## Community -Join the conversation on [Discord](https://discord.gg/ollama) or [Reddit](https://reddit.com/r/ollama). + + + Join the Ollama Discord. + + + + Join the Ollama subreddit. + + + + Follow Ollama on X. + + + + Explore Ollama on GitHub. + + diff --git a/docs/integrations/claude-code.mdx b/docs/integrations/claude-code.mdx index b27b8834f..93d234871 100644 --- a/docs/integrations/claude-code.mdx +++ b/docs/integrations/claude-code.mdx @@ -155,7 +155,7 @@ Claude Code prompts for permission on most actions. To allow the bot to work aut See the [plugin README](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/telegram) for setup instructions. -## Connect directly to Ollama Cloud +## Connect directly to Ollama's cloud Install Claude Code, then set your [API key](/quickstart#build-an-application) in `OLLAMA_API_KEY`. No Ollama installation required. diff --git a/docs/integrations/claude-desktop.mdx b/docs/integrations/claude-desktop.mdx index 3bfa3b176..258ad5f13 100644 --- a/docs/integrations/claude-desktop.mdx +++ b/docs/integrations/claude-desktop.mdx @@ -26,7 +26,7 @@ Open Ollama **Settings → Apps**. Choose your models, then select **Restart Cla - **Subagents** - Split larger tasks across agents - **Web search** - Supported by default through [Ollama's web search](/capabilities/web-search) -- **Cowork** - Complete difficult tasks with Claude Cowork +- **Cowork** - Complete difficult tasks with Claude Cowork - **Auto mode** - Let the agent decide when to ask before making changes ## Disconnect Claude diff --git a/docs/integrations/deepseek-harness.mdx b/docs/integrations/deepseek-harness.mdx index c09ff9817..1f659654f 100644 --- a/docs/integrations/deepseek-harness.mdx +++ b/docs/integrations/deepseek-harness.mdx @@ -27,7 +27,7 @@ ollama launch dsh --config ## Web search -Web search is enabled automatically. It requires Ollama cloud access and a model that supports tools. Run `ollama signin` if needed. +Web search is enabled automatically. It requires access to Ollama's cloud and a model that supports tools. Run `ollama signin` if needed. ## Configuration diff --git a/docs/integrations/droid.mdx b/docs/integrations/droid.mdx index 249554510..7ea182d46 100644 --- a/docs/integrations/droid.mdx +++ b/docs/integrations/droid.mdx @@ -56,7 +56,7 @@ Add the cloud configuration block to `~/.factory/config.json`: { "custom_models": [ { - "model_display_name": "qwen3-coder [Ollama Cloud]", + "model_display_name": "qwen3-coder [Ollama's cloud]", "model": "qwen3-coder:480b-cloud", "base_url": "http://localhost:11434/v1/", "api_key": "not-needed", @@ -76,7 +76,7 @@ Add the cloud configuration block to `~/.factory/config.json`: { "custom_models": [ { - "model_display_name": "qwen3-coder [Ollama Cloud]", + "model_display_name": "qwen3-coder [Ollama's cloud]", "model": "qwen3-coder:480b", "base_url": "https://ollama.com/v1/", "api_key": "OLLAMA_API_KEY", diff --git a/docs/integrations/marimo.mdx b/docs/integrations/marimo.mdx index 33815891b..73516cb47 100644 --- a/docs/integrations/marimo.mdx +++ b/docs/integrations/marimo.mdx @@ -68,6 +68,6 @@ would typically point the base url to `http://localhost:11434/v1`. ## Connecting to ollama.com -1. Sign in to ollama cloud via `ollama signin` +1. Sign in to Ollama's cloud with `ollama signin` 2. In the ollama model settings add a model that ollama hosts, like `gpt-oss:120b`. 3. You can now refer to this model in marimo! diff --git a/docs/integrations/onyx.mdx b/docs/integrations/onyx.mdx index e0587efb2..b5235ed37 100644 --- a/docs/integrations/onyx.mdx +++ b/docs/integrations/onyx.mdx @@ -51,7 +51,7 @@ Resourcing/scaling docs [here](https://docs.onyx.app/deployment/getting_started/ /> -You can also easily connect up Onyx Cloud with the `Ollama Cloud` tab of the setup. +You can also connect Onyx Cloud to Ollama's cloud from the setup flow. ## Send your first query
@@ -60,4 +60,4 @@ You can also easily connect up Onyx Cloud with the `Ollama Cloud` tab of the set alt="Onyx Query Example" width="75%" /> -
\ No newline at end of file + diff --git a/docs/local/index.mdx b/docs/local/index.mdx new file mode 100644 index 000000000..38520aadd --- /dev/null +++ b/docs/local/index.mdx @@ -0,0 +1,57 @@ +--- +title: Run Ollama locally +sidebarTitle: Overview +description: Install, configure, and run Ollama models on your own macOS, Windows, Linux, or Docker environment. +--- + +Run models on your own hardware with Ollama. Local inference keeps model execution on the machine or infrastructure you control and does not require an Ollama account. + +## Install Ollama + +Choose the installation guide for your environment. + + + + Install the Ollama app on Apple silicon or Intel hardware. + + + + Install the native Windows application. + + + + Install Ollama with the install script or a manual package. + + + + Run Ollama in a container with CPU or GPU acceleration. + + + +## Run a local model + +After installation, start a model from the terminal: + +```shell +ollama run gemma4 +``` + +Ollama also serves its local API at `http://localhost:11434/api` by default. + +```shell +curl http://localhost:11434/api/chat -d '{ + "model": "gemma4", + "messages": [{"role": "user", "content": "Why is the sky blue?"}], + "stream": false +}' +``` + +## Configure your environment + +- Use the [CLI reference](/cli) to run, download, copy, and remove models. +- Adjust the [context length](/context-length) for agents and other long-context workloads. +- Review [hardware support](/gpu) for GPU compatibility and acceleration. +- [Import a model](/import) or create a customized model with a [Modelfile](/modelfile). +- Use [local-only mode](/faq#how-do-i-disable-ollama-cloud-features) to disable Ollama's cloud features. + +For failures, start with [Troubleshooting](/troubleshooting). diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 6f2c2fe26..2a9ffe398 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -2116,7 +2116,7 @@ paths: operationId: usage servers: - url: https://ollama.com - description: Ollama Cloud + description: Ollama's cloud security: - bearerAuth: [] parameters: @@ -2184,7 +2184,7 @@ paths: operationId: balance servers: - url: https://ollama.com - description: Ollama Cloud + description: Ollama's cloud security: - bearerAuth: [] responses: diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 683251994..3297ce828 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -1,5 +1,6 @@ --- title: Quickstart +description: Use Ollama with desktop apps, coding agents, cloud APIs, or models running on your computer. --- Use Ollama in [desktop apps](#connect-a-desktop-app) and [coding agents](#use-a-coding-agent), or [build an application](#build-an-application) with an API key.