install.sh 12.6 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
42
43
44
    *icrosoft) error "Microsoft WSL1 is not currently supported. Please upgrade to WSL2 with 'wsl --set-version <distro> 2'" ;;
    *) ;;
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
Daniel Hiltgen's avatar
Daniel Hiltgen committed
69
OLLAMA_INSTALL_DIR=${OLLAMA_INSTALL_DIR:-${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
80
81
82
83
84
85
86
87
88
89
90
91
$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
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
fi

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
92

93
install_success() {
Josh's avatar
Josh committed
94
    status 'The Ollama API is now available at 127.0.0.1:11434.'
95
96
    status 'Install complete. Run "ollama" from the command line.'
}
97
98
99
trap install_success EXIT

# Everything from this point onwards is optional.
100
101

configure_systemd() {
102
103
    if ! id ollama >/dev/null 2>&1; then
        status "Creating ollama user..."
104
        $SUDO useradd -r -s /bin/false -U -m -d /usr/share/ollama ollama
105
    fi
106
107
108
109
    if getent group render >/dev/null 2>&1; then
        status "Adding ollama user to render group..."
        $SUDO usermod -a -G render ollama
    fi
110
111
112
113
    if getent group video >/dev/null 2>&1; then
        status "Adding ollama user to video group..."
        $SUDO usermod -a -G video ollama
    fi
114

115
116
117
    status "Adding current user to ollama group..."
    $SUDO usermod -a -G ollama $(whoami)

118
    status "Creating ollama systemd service..."
119
    cat <<EOF | $SUDO tee /etc/systemd/system/ollama.service >/dev/null
120
121
122
123
124
[Unit]
Description=Ollama Service
After=network-online.target

[Service]
125
ExecStart=$BINDIR/ollama serve
126
127
128
129
User=ollama
Group=ollama
Restart=always
RestartSec=3
Michael Yang's avatar
Michael Yang committed
130
Environment="PATH=$PATH"
131
132
133
134

[Install]
WantedBy=default.target
EOF
135
    SYSTEMCTL_RUNNING="$(systemctl is-system-running || true)"
Michael Yang's avatar
Michael Yang committed
136
137
138
139
140
    case $SYSTEMCTL_RUNNING in
        running|degraded)
            status "Enabling and starting ollama service..."
            $SUDO systemctl daemon-reload
            $SUDO systemctl enable ollama
141
142
143

            start_service() { $SUDO systemctl restart ollama; }
            trap start_service EXIT
Michael Yang's avatar
Michael Yang committed
144
145
            ;;
    esac
146
147
}

Michael Yang's avatar
Michael Yang committed
148
if available systemctl; then
149
    configure_systemd
150
151
fi

152
153
154
# WSL2 only supports GPUs via nvidia passthrough
# so check for nvidia-smi to determine if GPU is available
if [ "$IS_WSL2" = true ]; then
155
    if available nvidia-smi && [ -n "$(nvidia-smi | grep -o "CUDA Version: [0-9]*\.[0-9]*")" ]; then
156
157
158
159
160
161
162
        status "Nvidia GPU detected."
    fi
    install_success
    exit 0
fi

# Install GPU dependencies on Linux
Michael Yang's avatar
Michael Yang committed
163
if ! available lspci && ! available lshw; then
164
    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
165
166
167
    exit 0
fi

168
check_gpu() {
169
    # Look for devices based on vendor ID for NVIDIA and AMD
170
    case $1 in
171
        lspci)
172
173
174
175
            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 ;;
176
        lshw)
177
            case $2 in
178
179
                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 ;;
180
            esac ;;
Michael Yang's avatar
Michael Yang committed
181
        nvidia-smi) available nvidia-smi || return 1 ;;
182
    esac
183
184
}

185
186
187
188
189
if check_gpu nvidia-smi; then
    status "NVIDIA GPU installed."
    exit 0
fi

190
if ! check_gpu lspci nvidia && ! check_gpu lshw nvidia && ! check_gpu lspci amdgpu && ! check_gpu lshw amdgpu; then
191
    install_success
192
193
194
195
196
    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
197
198
199
200
201
    if [ $BUNDLE -ne 0 ]; then
        install_success
        status "AMD GPU ready."
        exit 0
    fi
202
    # Look for pre-existing ROCm v6 before downloading the dependencies
203
204
    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
205
206
207
208
209
210
211
212
213
214
215
216
217
            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
218
    status "AMD GPU ready."
219
220
221
    exit 0
fi

222
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/"
223
224
225
226
227
228
# 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...'
229
    
230
231
    case $PACKAGE_MANAGER in
        yum)
232
            $SUDO $PACKAGE_MANAGER -y install yum-utils
Daniel Hiltgen's avatar
Daniel Hiltgen committed
233
234
            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
235
236
237
            else
                error $CUDA_REPO_ERR_MSG
            fi
238
239
            ;;
        dnf)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
240
241
            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
242
243
244
            else
                error $CUDA_REPO_ERR_MSG
            fi
245
246
247
248
249
250
251
            ;;
    esac

    case $1 in
        rhel)
            status 'Installing EPEL repository...'
            # EPEL is required for third-party dependencies such as dkms and libvdpau
252
            $SUDO $PACKAGE_MANAGER -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-$2.noarch.rpm || true
253
254
255
256
257
258
            ;;
    esac

    status 'Installing CUDA driver...'

    if [ "$1" = 'centos' ] || [ "$1$2" = 'rhel7' ]; then
259
        $SUDO $PACKAGE_MANAGER -y install nvidia-driver-latest-dkms
260
    fi
261
262

    $SUDO $PACKAGE_MANAGER -y install cuda-drivers
263
264
265
266
267
268
}

# 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
269
270
    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
271
272
273
    else
        error $CUDA_REPO_ERR_MSG
    fi
274
275
276
277

    case $1 in
        debian)
            status 'Enabling contrib sources...'
278
            $SUDO sed 's/main/contrib/' < /etc/apt/sources.list | $SUDO tee /etc/apt/sources.list.d/contrib.list > /dev/null
279
280
281
            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
282
283
284
285
            ;;
    esac

    status 'Installing CUDA driver...'
286
287
    $SUDO dpkg -i $TEMP_DIR/cuda-keyring.deb
    $SUDO apt-get update
Michael Yang's avatar
Michael Yang committed
288
289
290

    [ -n "$SUDO" ] && SUDO_E="$SUDO -E" || SUDO_E=
    DEBIAN_FRONTEND=noninteractive $SUDO_E apt-get -y install cuda-drivers -q
291
292
293
294
295
296
297
298
299
300
301
302
303
}

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
304
    if available $PACKAGE_MANAGER; then
305
306
307
308
309
310
311
312
313
314
        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
315
        centos|rhel) install_cuda_driver_yum 'rhel' $(echo $OS_VERSION | cut -d '.' -f 1) ;;
316
        rocky) install_cuda_driver_yum 'rhel' $(echo $OS_VERSION | cut -c1) ;;
317
        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
318
        amzn) install_cuda_driver_yum 'fedora' '37' ;;
Michael Yang's avatar
Michael Yang committed
319
320
        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
321
        *) exit ;;
322
323
324
    esac
fi

325
if ! lsmod | grep -q nvidia || ! lsmod | grep -q nvidia_uvm; then
326
327
    KERNEL_RELEASE="$(uname -r)"
    case $OS_NAME in
328
329
        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
330
        fedora) $SUDO $PACKAGE_MANAGER -y install kernel-devel-$KERNEL_RELEASE ;;
331
        debian|ubuntu) $SUDO apt-get -y install linux-headers-$KERNEL_RELEASE ;;
Michael Yang's avatar
Michael Yang committed
332
        *) exit ;;
333
334
    esac

335
    NVIDIA_CUDA_VERSION=$($SUDO dkms status | awk -F: '/added/ { print $1 }')
Michael Yang's avatar
Michael Yang committed
336
337
338
339
    if [ -n "$NVIDIA_CUDA_VERSION" ]; then
        $SUDO dkms install $NVIDIA_CUDA_VERSION
    fi

340
341
342
343
344
345
346
347
    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
348

349
350
351
352
353
354
355
356
357
# make sure the NVIDIA modules are loaded on boot with nvidia-persistenced
if command -v nvidia-persistenced > /dev/null 2>&1; then
    $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
            echo "$MODULE" | sudo tee -a /etc/modules-load.d/nvidia.conf > /dev/null
        fi
    done
358
fi
359

360
status "NVIDIA GPU ready."
361
install_success