|
| 1 | +{/* |
| 2 | +SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 3 | +SPDX-License-Identifier: Apache-2.0 |
| 4 | +*/} |
| 5 | + |
| 6 | +# Upgrade Guide |
| 7 | + |
| 8 | +Updating to PAIR 1.0.0 works the same way as any other update. Your settings, |
| 9 | +cluster membership, and downloaded models all carry over, so for most machines |
| 10 | +there is nothing extra to do. Install the update as described in |
| 11 | +[Keeping PAIR Up to Date](getting-started.mdx#keeping-pair-up-to-date), and |
| 12 | +update each machine in your cluster so they all run the same version. |
| 13 | + |
| 14 | +A few situations call for a small extra step. Each section below says who it |
| 15 | +applies to, so you can skip the ones that do not: |
| 16 | + |
| 17 | +- [On macOS, tidy up the old app](#on-macos-tidy-up-the-old-app) |
| 18 | +- [If an earlier PAIR installed LM Studio for you](#if-an-earlier-pair-installed-lm-studio-for-you) |
| 19 | +- [If you use PAIR from a web page or browser extension](#if-you-use-pair-from-a-web-page-or-browser-extension) |
| 20 | + |
| 21 | +For everything that is new in this release, refer to |
| 22 | +[Release Notes](release-notes.mdx). |
| 23 | + |
| 24 | +## On macOS, Tidy Up the Old App |
| 25 | + |
| 26 | +The macOS application is now called **NVIDIA PAIR**. Earlier versions were |
| 27 | +installed as `PAIR.app`, and because the name changed, the new disk image adds |
| 28 | +`NVIDIA PAIR.app` beside the old app instead of replacing it. Keep just one by |
| 29 | +removing the old app with the uninstaller it includes. The uninstaller keeps |
| 30 | +your settings, cluster membership, engines, and models. |
| 31 | + |
| 32 | +1. Quit PAIR. |
| 33 | +2. In Terminal, run the old app's uninstaller: |
| 34 | + |
| 35 | + ```bash |
| 36 | + sudo /Applications/PAIR.app/Contents/Resources/installer-tools/uninstall-macos.sh |
| 37 | + ``` |
| 38 | + |
| 39 | + It finishes with `User data preserved`. Leave off the `--purge` option, which |
| 40 | + is only for removing PAIR's data as well. |
| 41 | +3. Open the new disk image, drag **NVIDIA PAIR** to **Applications**, and launch |
| 42 | + it from there. |
| 43 | + |
| 44 | +The uninstaller is a better choice than dragging the old app to the Trash, |
| 45 | +because it also removes PAIR's firewall rules and the helper that manages them. |
| 46 | + |
| 47 | +If you updated from within PAIR using **Restart & install**, the update was |
| 48 | +applied to your existing app, which keeps working under the `PAIR.app` name. |
| 49 | +PAIR finds its files and data from wherever the app is, not by its name, so |
| 50 | +there is nothing more to do unless you also install `NVIDIA PAIR.app` from the |
| 51 | +disk image, in which case remove `PAIR.app` as above. If PAIR does not reopen |
| 52 | +after **Restart & install**, open it from **Applications**. |
| 53 | + |
| 54 | +## If an Earlier PAIR Installed LM Studio for You |
| 55 | + |
| 56 | +This applies only if you used an earlier version of PAIR to install LM Studio. |
| 57 | +That LM Studio keeps working with PAIR 1.0.0 exactly as before. |
| 58 | + |
| 59 | +What is different is how PAIR cleans up. PAIR now keeps a record of the engines |
| 60 | +it installs, so that removing PAIR, or resetting its data, only ever removes |
| 61 | +engines PAIR put there itself. Earlier versions did not keep that record, so |
| 62 | +PAIR treats an LM Studio they installed as one you installed yourself, and |
| 63 | +leaves it in place. **Uninstall** in LM Studio's **Engine settings** says so, |
| 64 | +and **Reset app data** and uninstalling PAIR skip it. |
| 65 | + |
| 66 | +If you are happy to keep LM Studio, you do not need to do anything. If you would |
| 67 | +rather remove it, or have PAIR manage it from now on, follow these steps. They |
| 68 | +keep the models you downloaded. |
| 69 | + |
| 70 | +1. If you also use the LM Studio desktop application, remove LM Studio through |
| 71 | + that application instead, since it shares the same `.lmstudio` folder. |
| 72 | +2. Quit PAIR, which stops the LM Studio server it started. |
| 73 | +3. Stop LM Studio and delete everything in `.lmstudio` except the `models` |
| 74 | + folder. |
| 75 | + |
| 76 | + On macOS or Linux: |
| 77 | + |
| 78 | + ```bash |
| 79 | + ~/.lmstudio/bin/lms server stop |
| 80 | + find ~/.lmstudio -mindepth 1 -maxdepth 1 ! -name models -exec rm -rf {} + |
| 81 | + ``` |
| 82 | + |
| 83 | + On Windows, in PowerShell: |
| 84 | + |
| 85 | + ```powershell |
| 86 | + & "$env:USERPROFILE\.lmstudio\bin\lms.exe" server stop |
| 87 | + Get-ChildItem "$env:USERPROFILE\.lmstudio" -Force | |
| 88 | + Where-Object Name -ne 'models' | |
| 89 | + Remove-Item -Recurse -Force |
| 90 | + ``` |
| 91 | + |
| 92 | + To remove your downloaded LM Studio models too, delete the whole `.lmstudio` |
| 93 | + folder instead. |
| 94 | + |
| 95 | +To have PAIR manage LM Studio from now on, install it again from |
| 96 | +**Engine settings** after these steps. PAIR keeps a record of that install, and |
| 97 | +your kept `models` folder is still there for it to use. |
| 98 | + |
| 99 | +## If You Use PAIR from a Web Page or Browser Extension |
| 100 | + |
| 101 | +This applies only to browser-based clients. Command-line tools, IDEs, agents, |
| 102 | +and desktop applications are not affected. |
| 103 | + |
| 104 | +PAIR's local endpoints now use each engine's own browser access setting, known |
| 105 | +as CORS, rather than allowing every website. That means a web page can reach |
| 106 | +your models through PAIR only if you have allowed it in the engine. If a |
| 107 | +browser-based client stopped connecting after the update, add its address in |
| 108 | +the engine's launch options: |
| 109 | + |
| 110 | +| Engine | Setting | |
| 111 | +| --- | --- | |
| 112 | +| Ollama | `OLLAMA_ORIGINS`, for example `OLLAMA_ORIGINS="https://example.com"` | |
| 113 | +| LM Studio | The `--cors` switch | |
| 114 | +| llama.cpp | `--cors-origins` | |
| 115 | + |
| 116 | +Make the change on the machine that runs the engine. Include the address's |
| 117 | +scheme, such as `https://`; a wildcard on its own (`*`) or a bare `localhost` |
| 118 | +is not accepted. If requests can be routed to other machines in your cluster, |
| 119 | +allow the address on each of them. [Engine Settings](engine-settings.mdx) has |
| 120 | +the details. |
| 121 | + |
| 122 | +## Checking Everything Is Working |
| 123 | + |
| 124 | +After updating each machine, you can confirm that **Settings → Service** shows |
| 125 | +the new version, its engines are running in **Overview**, and its paired |
| 126 | +machines are still listed. If anything looks wrong, |
| 127 | +[Troubleshooting](troubleshooting.mdx) can help. |
0 commit comments