Skip to content

Commit 66fb857

Browse files
authored
doc: add MacOS docs (ollama#11334)
also removes stale model dir instructions for windows
1 parent 20c3266 commit 66fb857

File tree

4 files changed

+56
-14
lines changed

4 files changed

+56
-14
lines changed

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* [Quickstart](../README.md#quickstart)
55
* [Examples](./examples.md)
66
* [Importing models](./import.md)
7+
* [MacOS Documentation](./macos.md)
78
* [Linux Documentation](./linux.md)
89
* [Windows Documentation](./windows.md)
910
* [Docker Documentation](./docker.md)

docs/faq.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,3 +333,16 @@ The currently available K/V cache quantization types are:
333333
How much the cache quantization impacts the model's response quality will depend on the model and the task. Models that have a high GQA count (e.g. Qwen2) may see a larger impact on precision from quantization than models with a low GQA count.
334334

335335
You may need to experiment with different quantization types to find the best balance between memory usage and quality.
336+
337+
## How can I stop Ollama from starting when I login to my computer
338+
339+
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.
340+
341+
**Windows**
342+
- Remove `%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup\Ollama.lnk`
343+
344+
**MacOS Monterey (v12)**
345+
- Open `Settings` -> `Users & Groups` -> `Login Items` and find the `Ollama` entry, then click the `-` (minus) to remove
346+
347+
**MacOS Ventura (v13) and later**
348+
- Open `Settings` and search for "Login Items", find the `Ollama` entry under "Allow in the Background`, then click the slider to disable.

docs/macos.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Ollama for macOS
2+
3+
## System Requirements
4+
5+
* MacOS Monterey (v12) or newer
6+
* Apple M series (CPU and GPU support) or x86 (CPU only)
7+
8+
9+
## Filesystem Requirements
10+
11+
The preferred method of installation is to mount the `ollama.dmg` and drag-and-drop the Ollama application to the system-wide `Applications` folder. Upon startup, the Ollama app will verify the `ollama` CLI is present in your PATH, and if not detected, will prompt for permission to create a link in `/usr/local/bin`
12+
13+
Once you've installed Ollama, you'll need additional space for storing the Large Language models, which can be tens to hundreds of GB in size. If your home directory doesn't have enough space, you can change where the binaries are installed, and where the models are stored.
14+
15+
### Changing Install Location
16+
17+
To install the Ollama application somewhere other than `Applications`, place the Ollama application in the desired location, and ensure the CLI `Ollama.app/Contents/Resources/ollama` or a sym-link to the CLI can be found in your path. Upon first start decline the "Move to Applications?" request.
18+
19+
20+
## Troubleshooting
21+
22+
Ollama on MacOS stores files in a few different locations.
23+
- `~/.ollama` contains models and configuration
24+
- `~/.ollama/logs` contains logs
25+
- *app.log* contains most resent logs from the GUI application
26+
- *server.log* contains the most recent server logs
27+
- `<install location>/Ollama.app/Contents/Resources/ollama` the CLI binary
28+
29+
## Uninstall
30+
31+
To fully remove Ollama from your system, remove the following files and folders:
32+
33+
```
34+
sudo rm -rf /Applications/Ollama.app
35+
sudo rm /usr/local/bin/ollama
36+
rm -rf "~/Library/Application Support/Ollama"
37+
rm -rf "~/Library/Saved Application State/com.electron.ollama.savedState"
38+
rm -rf ~/Library/Caches/com.electron.ollama/
39+
rm -rf ~/Library/Caches/ollama
40+
rm -rf ~/Library/WebKit/com.electron.ollama
41+
rm -rf ~/.ollama
42+
```

docs/windows.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,6 @@ To install the Ollama application in a location different than your home directo
3030
OllamaSetup.exe /DIR="d:\some\location"
3131
```
3232

33-
### Changing Model Location
34-
35-
To change where Ollama stores the downloaded models instead of using your home directory, set the environment variable `OLLAMA_MODELS` in your user account.
36-
37-
1. Start the Settings (Windows 11) or Control Panel (Windows 10) application and search for _environment variables_.
38-
39-
2. Click on _Edit environment variables for your account_.
40-
41-
3. Edit or create a new variable for your user account for `OLLAMA_MODELS` where you want the models stored
42-
43-
4. Click OK/Apply to save.
44-
45-
If Ollama is already running, Quit the tray application and relaunch it from the Start menu, or a new terminal started after you saved the environment variables.
46-
4733
## API Access
4834

4935
Here's a quick example showing API access from `powershell`

0 commit comments

Comments
 (0)