install.sh 14.4 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
red="$( (/usr/bin/tput bold || :; /usr/bin/tput setaf 1 || :) 2>&-)"
plain="$( (/usr/bin/tput sgr0 || :) 2>&-)"
9

10
status() { echo ">>> $*" >&2; }
11
12
error() { echo "${red}ERROR:${plain} $*"; exit 1; }
warning() { echo "${red}WARNING:${plain} $*"; }
13

14
15
16
TEMP_DIR=$(mktemp -d)
cleanup() { rm -rf $TEMP_DIR; }
trap cleanup EXIT
17

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

    echo $MISSING
28
29
}

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

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
39
40
IS_WSL2=false

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

48
VER_PARAM="${OLLAMA_VERSION:+?version=$OLLAMA_VERSION}"
49

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

    SUDO="sudo"
58
fi
59

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
74
status "Installing ollama to $OLLAMA_INSTALL_DIR"
75
$SUDO install -o0 -g0 -m755 -d $BINDIR
Daniel Hiltgen's avatar
Daniel Hiltgen committed
76
77
78
79
80
81
82
$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
83
84
85
86
    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
87
88
89
90
91
92
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
93
94
95
96
    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
97
98
fi

99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# 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
115

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

# Everything from this point onwards is optional.
123
124

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

138
139
140
    status "Adding current user to ollama group..."
    $SUDO usermod -a -G ollama $(whoami)

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

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

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

            start_service() { $SUDO systemctl restart ollama; }
            trap start_service EXIT
Michael Yang's avatar
Michael Yang committed
167
            ;;
168
169
170
171
172
173
        *)
            warning "systemd is not running"
            if [ "$IS_WSL2" = true ]; then
                warning "see https://learn.microsoft.com/en-us/windows/wsl/systemd#how-to-enable-systemd to enable it"
            fi
            ;;
Michael Yang's avatar
Michael Yang committed
174
    esac
175
176
}

Michael Yang's avatar
Michael Yang committed
177
if available systemctl; then
178
    configure_systemd
179
180
fi

181
182
183
# WSL2 only supports GPUs via nvidia passthrough
# so check for nvidia-smi to determine if GPU is available
if [ "$IS_WSL2" = true ]; then
184
    if available nvidia-smi && [ -n "$(nvidia-smi | grep -o "CUDA Version: [0-9]*\.[0-9]*")" ]; then
185
186
187
188
189
190
        status "Nvidia GPU detected."
    fi
    install_success
    exit 0
fi

191
192
193
194
195
196
197
# 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

198
# Install GPU dependencies on Linux
Michael Yang's avatar
Michael Yang committed
199
if ! available lspci && ! available lshw; then
200
    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
201
202
203
    exit 0
fi

204
check_gpu() {
205
    # Look for devices based on vendor ID for NVIDIA and AMD
206
    case $1 in
207
        lspci)
208
209
210
211
            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 ;;
212
        lshw)
213
            case $2 in
214
215
                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 ;;
216
            esac ;;
Michael Yang's avatar
Michael Yang committed
217
        nvidia-smi) available nvidia-smi || return 1 ;;
218
    esac
219
220
}

221
222
223
224
225
if check_gpu nvidia-smi; then
    status "NVIDIA GPU installed."
    exit 0
fi

226
if ! check_gpu lspci nvidia && ! check_gpu lshw nvidia && ! check_gpu lspci amdgpu && ! check_gpu lshw amdgpu; then
227
    install_success
228
229
230
231
232
    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
233
    if [ $BUNDLE -ne 0 ]; then
234
235
236
237
238
        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
239
240
241
242
        install_success
        status "AMD GPU ready."
        exit 0
    fi
243
    # Look for pre-existing ROCm v6 before downloading the dependencies
244
245
    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
246
247
248
249
250
251
252
253
254
255
256
257
258
            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
259
    status "AMD GPU ready."
260
261
262
    exit 0
fi

263
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/"
264
265
266
267
268
269
# 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...'
270
    
271
272
    case $PACKAGE_MANAGER in
        yum)
273
            $SUDO $PACKAGE_MANAGER -y install yum-utils
Daniel Hiltgen's avatar
Daniel Hiltgen committed
274
275
            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
276
277
278
            else
                error $CUDA_REPO_ERR_MSG
            fi
279
280
            ;;
        dnf)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
281
282
            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
283
284
285
            else
                error $CUDA_REPO_ERR_MSG
            fi
286
287
288
289
290
291
292
            ;;
    esac

    case $1 in
        rhel)
            status 'Installing EPEL repository...'
            # EPEL is required for third-party dependencies such as dkms and libvdpau
293
            $SUDO $PACKAGE_MANAGER -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-$2.noarch.rpm || true
294
295
296
297
298
299
            ;;
    esac

    status 'Installing CUDA driver...'

    if [ "$1" = 'centos' ] || [ "$1$2" = 'rhel7' ]; then
300
        $SUDO $PACKAGE_MANAGER -y install nvidia-driver-latest-dkms
301
    fi
302
303

    $SUDO $PACKAGE_MANAGER -y install cuda-drivers
304
305
306
307
308
309
}

# 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
310
311
    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
312
313
314
    else
        error $CUDA_REPO_ERR_MSG
    fi
315
316
317
318

    case $1 in
        debian)
            status 'Enabling contrib sources...'
319
            $SUDO sed 's/main/contrib/' < /etc/apt/sources.list | $SUDO tee /etc/apt/sources.list.d/contrib.list > /dev/null
320
321
322
            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
323
324
325
326
            ;;
    esac

    status 'Installing CUDA driver...'
327
328
    $SUDO dpkg -i $TEMP_DIR/cuda-keyring.deb
    $SUDO apt-get update
Michael Yang's avatar
Michael Yang committed
329
330
331

    [ -n "$SUDO" ] && SUDO_E="$SUDO -E" || SUDO_E=
    DEBIAN_FRONTEND=noninteractive $SUDO_E apt-get -y install cuda-drivers -q
332
333
334
335
336
337
338
339
340
341
342
343
344
}

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
345
    if available $PACKAGE_MANAGER; then
346
347
348
349
350
351
352
353
354
355
        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
356
        centos|rhel) install_cuda_driver_yum 'rhel' $(echo $OS_VERSION | cut -d '.' -f 1) ;;
357
        rocky) install_cuda_driver_yum 'rhel' $(echo $OS_VERSION | cut -c1) ;;
358
        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
359
        amzn) install_cuda_driver_yum 'fedora' '37' ;;
Michael Yang's avatar
Michael Yang committed
360
361
        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
362
        *) exit ;;
363
364
365
    esac
fi

366
if ! lsmod | grep -q nvidia || ! lsmod | grep -q nvidia_uvm; then
367
368
    KERNEL_RELEASE="$(uname -r)"
    case $OS_NAME in
369
370
        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
371
        fedora) $SUDO $PACKAGE_MANAGER -y install kernel-devel-$KERNEL_RELEASE ;;
372
        debian|ubuntu) $SUDO apt-get -y install linux-headers-$KERNEL_RELEASE ;;
Michael Yang's avatar
Michael Yang committed
373
        *) exit ;;
374
375
    esac

376
    NVIDIA_CUDA_VERSION=$($SUDO dkms status | awk -F: '/added/ { print $1 }')
Michael Yang's avatar
Michael Yang committed
377
378
379
380
    if [ -n "$NVIDIA_CUDA_VERSION" ]; then
        $SUDO dkms install $NVIDIA_CUDA_VERSION
    fi

381
382
383
384
385
386
387
388
    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
389

390
# make sure the NVIDIA modules are loaded on boot with nvidia-persistenced
391
if available nvidia-persistenced; then
392
393
394
395
    $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
396
            echo "$MODULE" | $SUDO tee -a /etc/modules-load.d/nvidia.conf > /dev/null
397
398
        fi
    done
399
fi
400

401
status "NVIDIA GPU ready."
402
install_success