install.sh 14 KB
Newer Older
1
2
3
4
5
6
#!/bin/sh
# This script installs Ollama on Linux.
# It detects the current operating system architecture and installs the appropriate version of Ollama.

set -eu

7
8
status() { echo ">>> $*" >&2; }
error() { echo "ERROR $*"; exit 1; }
9
warning() { echo "WARNING: $*"; }
10

11
12
13
TEMP_DIR=$(mktemp -d)
cleanup() { rm -rf $TEMP_DIR; }
trap cleanup EXIT
14

Michael Yang's avatar
Michael Yang committed
15
16
available() { command -v $1 >/dev/null; }
require() {
17
18
    local MISSING=''
    for TOOL in $*; do
Michael Yang's avatar
Michael Yang committed
19
        if ! available $TOOL; then
20
            MISSING="$MISSING $TOOL"
21
        fi
22
23
24
    done

    echo $MISSING
25
26
}

27
[ "$(uname -s)" = "Linux" ] || error 'This script is intended to run on Linux only.'
28

29
30
ARCH=$(uname -m)
case "$ARCH" in
31
32
33
34
    x86_64) ARCH="amd64" ;;
    aarch64|arm64) ARCH="arm64" ;;
    *) error "Unsupported architecture: $ARCH" ;;
esac
35

Jeffrey Morgan's avatar
Jeffrey Morgan committed
36
37
IS_WSL2=false

38
39
KERN=$(uname -r)
case "$KERN" in
40
    *icrosoft*WSL2 | *icrosoft*wsl2) IS_WSL2=true;;
41
    *icrosoft) error "Microsoft WSL1 is not currently supported. Please use WSL2 with 'wsl --set-version <distro> 2'" ;;
42
43
44
    *) ;;
esac

45
VER_PARAM="${OLLAMA_VERSION:+?version=$OLLAMA_VERSION}"
46

47
SUDO=
48
49
if [ "$(id -u)" -ne 0 ]; then
    # Running as root, no need for sudo
Michael Yang's avatar
Michael Yang committed
50
    if ! available sudo; then
Michael Yang's avatar
Michael Yang committed
51
        error "This script requires superuser permissions. Please re-run as root."
52
    fi
53
54

    SUDO="sudo"
55
fi
56

Michael Yang's avatar
Michael Yang committed
57
58
NEEDS=$(require curl awk grep sed tee xargs)
if [ -n "$NEEDS" ]; then
Michael Yang's avatar
Michael Yang committed
59
    status "ERROR: The following tools are required but missing:"
Michael Yang's avatar
Michael Yang committed
60
61
    for NEED in $NEEDS; do
        echo "  - $NEED"
Michael Yang's avatar
Michael Yang committed
62
63
    done
    exit 1
64
65
fi

66
67
68
for BINDIR in /usr/local/bin /usr/bin /bin; do
    echo $PATH | grep -q $BINDIR && break || continue
done
69
OLLAMA_INSTALL_DIR=$(dirname ${BINDIR})
70

Daniel Hiltgen's avatar
Daniel Hiltgen committed
71
status "Installing ollama to $OLLAMA_INSTALL_DIR"
72
$SUDO install -o0 -g0 -m755 -d $BINDIR
Daniel Hiltgen's avatar
Daniel Hiltgen committed
73
74
75
76
77
78
79
$SUDO install -o0 -g0 -m755 -d "$OLLAMA_INSTALL_DIR"
if curl -I --silent --fail --location "https://ollama.com/download/ollama-linux-${ARCH}.tgz${VER_PARAM}" >/dev/null ; then
    status "Downloading Linux ${ARCH} bundle"
    curl --fail --show-error --location --progress-bar \
        "https://ollama.com/download/ollama-linux-${ARCH}.tgz${VER_PARAM}" | \
        $SUDO tar -xzf - -C "$OLLAMA_INSTALL_DIR"
    BUNDLE=1
80
81
82
83
    if [ "$OLLAMA_INSTALL_DIR/bin/ollama" != "$BINDIR/ollama" ] ; then
        status "Making ollama accessible in the PATH in $BINDIR"
        $SUDO ln -sf "$OLLAMA_INSTALL_DIR/ollama" "$BINDIR/ollama"
    fi
Daniel Hiltgen's avatar
Daniel Hiltgen committed
84
85
86
87
88
89
else
    status "Downloading Linux ${ARCH} CLI"
    curl --fail --show-error --location --progress-bar -o "$TEMP_DIR/ollama"\
    "https://ollama.com/download/ollama-linux-${ARCH}${VER_PARAM}"
    $SUDO install -o0 -g0 -m755 $TEMP_DIR/ollama $OLLAMA_INSTALL_DIR/ollama
    BUNDLE=0
90
91
92
93
    if [ "$OLLAMA_INSTALL_DIR/ollama" != "$BINDIR/ollama" ] ; then
        status "Making ollama accessible in the PATH in $BINDIR"
        $SUDO ln -sf "$OLLAMA_INSTALL_DIR/ollama" "$BINDIR/ollama"
    fi
Daniel Hiltgen's avatar
Daniel Hiltgen committed
94
95
fi

96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# Check for NVIDIA JetPack systems with additional downloads
if [ -f /etc/nv_tegra_release ] ; then
    if grep R36 /etc/nv_tegra_release > /dev/null ; then
        status "Downloading JetPack 6 components"
        curl --fail --show-error --location --progress-bar \
            "https://ollama.com/download/ollama-linux-${ARCH}-jetpack6.tgz${VER_PARAM}" | \
            $SUDO tar -xzf - -C "$OLLAMA_INSTALL_DIR"
    elif grep R35 /etc/nv_tegra_release > /dev/null ; then
        status "Downloading JetPack 5 components"
        curl --fail --show-error --location --progress-bar \
            "https://ollama.com/download/ollama-linux-${ARCH}-jetpack5.tgz${VER_PARAM}" | \
            $SUDO tar -xzf - -C "$OLLAMA_INSTALL_DIR"
    else
        warning "Unsupported JetPack version detected.  GPU may not be supported"
    fi
fi
112

113
install_success() {
Josh's avatar
Josh committed
114
    status 'The Ollama API is now available at 127.0.0.1:11434.'
115
116
    status 'Install complete. Run "ollama" from the command line.'
}
117
118
119
trap install_success EXIT

# Everything from this point onwards is optional.
120
121

configure_systemd() {
122
123
    if ! id ollama >/dev/null 2>&1; then
        status "Creating ollama user..."
124
        $SUDO useradd -r -s /bin/false -U -m -d /usr/share/ollama ollama
125
    fi
126
127
128
129
    if getent group render >/dev/null 2>&1; then
        status "Adding ollama user to render group..."
        $SUDO usermod -a -G render ollama
    fi
130
131
132
133
    if getent group video >/dev/null 2>&1; then
        status "Adding ollama user to video group..."
        $SUDO usermod -a -G video ollama
    fi
134

135
136
137
    status "Adding current user to ollama group..."
    $SUDO usermod -a -G ollama $(whoami)

138
    status "Creating ollama systemd service..."
139
    cat <<EOF | $SUDO tee /etc/systemd/system/ollama.service >/dev/null
140
141
142
143
144
[Unit]
Description=Ollama Service
After=network-online.target

[Service]
145
ExecStart=$BINDIR/ollama serve
146
147
148
149
User=ollama
Group=ollama
Restart=always
RestartSec=3
Michael Yang's avatar
Michael Yang committed
150
Environment="PATH=$PATH"
151
152
153
154

[Install]
WantedBy=default.target
EOF
155
    SYSTEMCTL_RUNNING="$(systemctl is-system-running || true)"
Michael Yang's avatar
Michael Yang committed
156
157
158
159
160
    case $SYSTEMCTL_RUNNING in
        running|degraded)
            status "Enabling and starting ollama service..."
            $SUDO systemctl daemon-reload
            $SUDO systemctl enable ollama
161
162
163

            start_service() { $SUDO systemctl restart ollama; }
            trap start_service EXIT
Michael Yang's avatar
Michael Yang committed
164
165
            ;;
    esac
166
167
}

Michael Yang's avatar
Michael Yang committed
168
if available systemctl; then
169
    configure_systemd
170
171
fi

172
173
174
# WSL2 only supports GPUs via nvidia passthrough
# so check for nvidia-smi to determine if GPU is available
if [ "$IS_WSL2" = true ]; then
175
    if available nvidia-smi && [ -n "$(nvidia-smi | grep -o "CUDA Version: [0-9]*\.[0-9]*")" ]; then
176
177
178
179
180
181
        status "Nvidia GPU detected."
    fi
    install_success
    exit 0
fi

182
183
184
185
186
187
188
# Don't attempt to install drivers on Jetson systems
if [ -f /etc/nv_tegra_release ] ; then
    status "NVIDIA JetPack ready."
    install_success
    exit 0
fi

189
# Install GPU dependencies on Linux
Michael Yang's avatar
Michael Yang committed
190
if ! available lspci && ! available lshw; then
191
    warning "Unable to detect NVIDIA/AMD GPU. Install lspci or lshw to automatically detect and install GPU dependencies."
Michael Yang's avatar
Michael Yang committed
192
193
194
    exit 0
fi

195
check_gpu() {
196
    # Look for devices based on vendor ID for NVIDIA and AMD
197
    case $1 in
198
        lspci)
199
200
201
202
            case $2 in
                nvidia) available lspci && lspci -d '10de:' | grep -q 'NVIDIA' || return 1 ;;
                amdgpu) available lspci && lspci -d '1002:' | grep -q 'AMD' || return 1 ;;
            esac ;;
203
        lshw)
204
            case $2 in
205
206
                nvidia) available lshw && $SUDO lshw -c display -numeric -disable network | grep -q 'vendor: .* \[10DE\]' || return 1 ;;
                amdgpu) available lshw && $SUDO lshw -c display -numeric -disable network | grep -q 'vendor: .* \[1002\]' || return 1 ;;
207
            esac ;;
Michael Yang's avatar
Michael Yang committed
208
        nvidia-smi) available nvidia-smi || return 1 ;;
209
    esac
210
211
}

212
213
214
215
216
if check_gpu nvidia-smi; then
    status "NVIDIA GPU installed."
    exit 0
fi

217
if ! check_gpu lspci nvidia && ! check_gpu lshw nvidia && ! check_gpu lspci amdgpu && ! check_gpu lshw amdgpu; then
218
    install_success
219
220
221
222
223
    warning "No NVIDIA/AMD GPU detected. Ollama will run in CPU-only mode."
    exit 0
fi

if check_gpu lspci amdgpu || check_gpu lshw amdgpu; then
Daniel Hiltgen's avatar
Daniel Hiltgen committed
224
    if [ $BUNDLE -ne 0 ]; then
225
226
227
228
229
        status "Downloading Linux ROCm ${ARCH} bundle"
        curl --fail --show-error --location --progress-bar \
            "https://ollama.com/download/ollama-linux-${ARCH}-rocm.tgz${VER_PARAM}" | \
            $SUDO tar -xzf - -C "$OLLAMA_INSTALL_DIR"

Daniel Hiltgen's avatar
Daniel Hiltgen committed
230
231
232
233
        install_success
        status "AMD GPU ready."
        exit 0
    fi
234
    # Look for pre-existing ROCm v6 before downloading the dependencies
235
236
    for search in "${HIP_PATH:-''}" "${ROCM_PATH:-''}" "/opt/rocm" "/usr/lib64"; do
        if [ -n "${search}" ] && [ -e "${search}/libhipblas.so.2" -o -e "${search}/lib/libhipblas.so.2" ]; then
237
238
239
240
241
242
243
244
245
246
247
248
249
            status "Compatible AMD GPU ROCm library detected at ${search}"
            install_success
            exit 0
        fi
    done

    status "Downloading AMD GPU dependencies..."
    $SUDO rm -rf /usr/share/ollama/lib
    $SUDO chmod o+x /usr/share/ollama
    $SUDO install -o ollama -g ollama -m 755 -d /usr/share/ollama/lib/rocm
    curl --fail --show-error --location --progress-bar "https://ollama.com/download/ollama-linux-amd64-rocm.tgz${VER_PARAM}" \
        | $SUDO tar zx --owner ollama --group ollama -C /usr/share/ollama/lib/rocm .
    install_success
250
    status "AMD GPU ready."
251
252
253
    exit 0
fi

254
CUDA_REPO_ERR_MSG="NVIDIA GPU detected, but your OS and Architecture are not supported by NVIDIA.  Please install the CUDA driver manually https://docs.nvidia.com/cuda/cuda-installation-guide-linux/"
255
256
257
258
259
260
# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#rhel-7-centos-7
# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#rhel-8-rocky-8
# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#rhel-9-rocky-9
# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#fedora
install_cuda_driver_yum() {
    status 'Installing NVIDIA repository...'
261
    
262
263
    case $PACKAGE_MANAGER in
        yum)
264
            $SUDO $PACKAGE_MANAGER -y install yum-utils
Daniel Hiltgen's avatar
Daniel Hiltgen committed
265
266
            if curl -I --silent --fail --location "https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-$1$2.repo" >/dev/null ; then
                $SUDO $PACKAGE_MANAGER-config-manager --add-repo https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-$1$2.repo
267
268
269
            else
                error $CUDA_REPO_ERR_MSG
            fi
270
271
            ;;
        dnf)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
272
273
            if curl -I --silent --fail --location "https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-$1$2.repo" >/dev/null ; then
                $SUDO $PACKAGE_MANAGER config-manager --add-repo https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-$1$2.repo
274
275
276
            else
                error $CUDA_REPO_ERR_MSG
            fi
277
278
279
280
281
282
283
            ;;
    esac

    case $1 in
        rhel)
            status 'Installing EPEL repository...'
            # EPEL is required for third-party dependencies such as dkms and libvdpau
284
            $SUDO $PACKAGE_MANAGER -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-$2.noarch.rpm || true
285
286
287
288
289
290
            ;;
    esac

    status 'Installing CUDA driver...'

    if [ "$1" = 'centos' ] || [ "$1$2" = 'rhel7' ]; then
291
        $SUDO $PACKAGE_MANAGER -y install nvidia-driver-latest-dkms
292
    fi
293
294

    $SUDO $PACKAGE_MANAGER -y install cuda-drivers
295
296
297
298
299
300
}

# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#ubuntu
# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#debian
install_cuda_driver_apt() {
    status 'Installing NVIDIA repository...'
Daniel Hiltgen's avatar
Daniel Hiltgen committed
301
302
    if curl -I --silent --fail --location "https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-keyring_1.1-1_all.deb" >/dev/null ; then
        curl -fsSL -o $TEMP_DIR/cuda-keyring.deb https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-keyring_1.1-1_all.deb
303
304
305
    else
        error $CUDA_REPO_ERR_MSG
    fi
306
307
308
309

    case $1 in
        debian)
            status 'Enabling contrib sources...'
310
            $SUDO sed 's/main/contrib/' < /etc/apt/sources.list | $SUDO tee /etc/apt/sources.list.d/contrib.list > /dev/null
311
312
313
            if [ -f "/etc/apt/sources.list.d/debian.sources" ]; then
                $SUDO sed 's/main/contrib/' < /etc/apt/sources.list.d/debian.sources | $SUDO tee /etc/apt/sources.list.d/contrib.sources > /dev/null
            fi
314
315
316
317
            ;;
    esac

    status 'Installing CUDA driver...'
318
319
    $SUDO dpkg -i $TEMP_DIR/cuda-keyring.deb
    $SUDO apt-get update
Michael Yang's avatar
Michael Yang committed
320
321
322

    [ -n "$SUDO" ] && SUDO_E="$SUDO -E" || SUDO_E=
    DEBIAN_FRONTEND=noninteractive $SUDO_E apt-get -y install cuda-drivers -q
323
324
325
326
327
328
329
330
331
332
333
334
335
}

if [ ! -f "/etc/os-release" ]; then
    error "Unknown distribution. Skipping CUDA installation."
fi

. /etc/os-release

OS_NAME=$ID
OS_VERSION=$VERSION_ID

PACKAGE_MANAGER=
for PACKAGE_MANAGER in dnf yum apt-get; do
Michael Yang's avatar
Michael Yang committed
336
    if available $PACKAGE_MANAGER; then
337
338
339
340
341
342
343
344
345
346
        break
    fi
done

if [ -z "$PACKAGE_MANAGER" ]; then
    error "Unknown package manager. Skipping CUDA installation."
fi

if ! check_gpu nvidia-smi || [ -z "$(nvidia-smi | grep -o "CUDA Version: [0-9]*\.[0-9]*")" ]; then
    case $OS_NAME in
347
        centos|rhel) install_cuda_driver_yum 'rhel' $(echo $OS_VERSION | cut -d '.' -f 1) ;;
348
        rocky) install_cuda_driver_yum 'rhel' $(echo $OS_VERSION | cut -c1) ;;
349
        fedora) [ $OS_VERSION -lt '39' ] && install_cuda_driver_yum $OS_NAME $OS_VERSION || install_cuda_driver_yum $OS_NAME '39';;
Michael Yang's avatar
Michael Yang committed
350
        amzn) install_cuda_driver_yum 'fedora' '37' ;;
Michael Yang's avatar
Michael Yang committed
351
352
        debian) install_cuda_driver_apt $OS_NAME $OS_VERSION ;;
        ubuntu) install_cuda_driver_apt $OS_NAME $(echo $OS_VERSION | sed 's/\.//') ;;
Michael Yang's avatar
Michael Yang committed
353
        *) exit ;;
354
355
356
    esac
fi

357
if ! lsmod | grep -q nvidia || ! lsmod | grep -q nvidia_uvm; then
358
359
    KERNEL_RELEASE="$(uname -r)"
    case $OS_NAME in
360
361
        rocky) $SUDO $PACKAGE_MANAGER -y install kernel-devel kernel-headers ;;
        centos|rhel|amzn) $SUDO $PACKAGE_MANAGER -y install kernel-devel-$KERNEL_RELEASE kernel-headers-$KERNEL_RELEASE ;;
Bruce MacDonald's avatar
Bruce MacDonald committed
362
        fedora) $SUDO $PACKAGE_MANAGER -y install kernel-devel-$KERNEL_RELEASE ;;
363
        debian|ubuntu) $SUDO apt-get -y install linux-headers-$KERNEL_RELEASE ;;
Michael Yang's avatar
Michael Yang committed
364
        *) exit ;;
365
366
    esac

367
    NVIDIA_CUDA_VERSION=$($SUDO dkms status | awk -F: '/added/ { print $1 }')
Michael Yang's avatar
Michael Yang committed
368
369
370
371
    if [ -n "$NVIDIA_CUDA_VERSION" ]; then
        $SUDO dkms install $NVIDIA_CUDA_VERSION
    fi

372
373
374
375
376
377
378
379
    if lsmod | grep -q nouveau; then
        status 'Reboot to complete NVIDIA CUDA driver install.'
        exit 0
    fi

    $SUDO modprobe nvidia
    $SUDO modprobe nvidia_uvm
fi
Michael Yang's avatar
Michael Yang committed
380

381
# make sure the NVIDIA modules are loaded on boot with nvidia-persistenced
382
if available nvidia-persistenced; then
383
384
385
386
    $SUDO touch /etc/modules-load.d/nvidia.conf
    MODULES="nvidia nvidia-uvm"
    for MODULE in $MODULES; do
        if ! grep -qxF "$MODULE" /etc/modules-load.d/nvidia.conf; then
387
            echo "$MODULE" | $SUDO tee -a /etc/modules-load.d/nvidia.conf > /dev/null
388
389
        fi
    done
390
fi
391

392
status "NVIDIA GPU ready."
393
install_success