Update install guides with new OS support matrix (#6309)

This commit is contained in:
Jakub Kuczys 2024-03-17 23:13:43 +01:00 committed by GitHub
parent edfb9ffe62
commit a30f9ff7e6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 67 additions and 111 deletions

View File

@ -1,27 +0,0 @@
----------------------------
Installing Python with pyenv
----------------------------
On distributions where Python 3.10 needs to be compiled from source, we recommend the use of pyenv.
This simplifies the compilation process and has the added bonus of simplifying setting up Red in a
virtual environment.
.. include:: _includes/_install-pyenv-and-setup-path.rst
.. prompt:: bash
CONFIGURE_OPTS=--enable-optimizations pyenv install 3.10.13 -v
This may take a long time to complete, depending on your hardware. For some machines (such as
Raspberry Pis and micro-tier VPSes), it may take over an hour; in this case, you may wish to remove
the ``CONFIGURE_OPTS=--enable-optimizations`` part from the front of the command, which will
drastically reduce the install time. However, be aware that this will make Python run about 10%
slower.
After that is finished, run:
.. prompt:: bash
pyenv global 3.10.13
Pyenv is now installed and your system should be configured to run Python 3.10.

View File

@ -18,20 +18,20 @@ Install the pre-requirements with pacman:
sudo pacman -Syu git jre17-openjdk-headless base-devel nano
On Arch Linux, Python 3.9 can be installed from the Arch User Repository (AUR) from the ``python39`` package.
On Arch Linux, Python 3.10 can be installed from the Arch User Repository (AUR) from the ``python310`` package.
The manual build process is the Arch-supported install method for AUR packages. You can install ``python39`` package with the following commands:
The manual build process is the Arch-supported install method for AUR packages. You can install ``python310`` package with the following commands:
.. prompt:: bash
git clone https://aur.archlinux.org/python39.git /tmp/python39
cd /tmp/python39
git clone https://aur.archlinux.org/python310.git /tmp/python310
cd /tmp/python310
makepkg -sicL
cd -
rm -rf /tmp/python39
rm -rf /tmp/python310
.. Include common instructions:
.. include:: _includes/create-env-with-venv3.9.rst
.. include:: _includes/create-env-with-venv3.10.rst
.. include:: _includes/install-and-setup-red-unix.rst

View File

@ -12,7 +12,7 @@ Installing Red on Fedora Linux
Installing the pre-requirements
-------------------------------
Fedora Linux 37 and above has all required packages available in official repositories. Install
Fedora Linux 38 and above has all required packages available in official repositories. Install
them with dnf:
.. prompt:: bash

View File

@ -26,8 +26,8 @@ we recommend **Ubuntu 22.04 LTS**.
opensuse-tumbleweed
oracle-linux-8
oracle-linux-9
raspberry-pi-os-10
raspberry-pi-os-11
raspberry-pi-os-12
rhel-8
rhel-9
rocky-linux-8

View File

@ -1,7 +1,7 @@
.. _install-opensuse-leap-15:
=====================================
Installing Red on openSUSE Leap 15.4+
Installing Red on openSUSE Leap 15.5+
=====================================
.. include:: _includes/supported-arch-x64+aarch64.rst
@ -12,16 +12,16 @@ Installing Red on openSUSE Leap 15.4+
Installing the pre-requirements
-------------------------------
openSUSE Leap 15.4+ has all required dependencies available in official repositories. Install them
openSUSE Leap 15.5+ has all required dependencies available in official repositories. Install them
with zypper:
.. prompt:: bash
sudo zypper -n install python310 python310-devel git-core java-17-openjdk-headless nano
sudo zypper -n install python311 python311-devel git-core java-17-openjdk-headless nano
sudo zypper -n install -t pattern devel_basis
.. Include common instructions:
.. include:: _includes/create-env-with-venv3.10.rst
.. include:: _includes/create-env-with-venv3.11.rst
.. include:: _includes/install-and-setup-red-unix.rst

View File

@ -1,55 +0,0 @@
.. _install-raspberry-pi-os-10:
====================================================
Installing Red on Raspberry Pi OS (Legacy) 10 Buster
====================================================
.. include:: _includes/supported-arch-armv7l.rst
.. note::
While we do provide support and install instructions for running Red
on Raspberry Pi OS (Legacy) 10 Buster, we highly recommend installing/upgrading to
the new version - Raspberry Pi OS 11 Bullseye.
If you're not sure what version you are using,
you can check your version of Raspberry Pi OS by running:
.. prompt:: bash
lsb_release -a
If you're running Bullseye already, read `install-raspberry-pi-os-11` document instead.
If you're using Buster, please consider upgrading to Bullseye if possible.
You can read
`the post about Bullseye release from Raspberry Pi Foundation <https://www.raspberrypi.com/news/raspberry-pi-os-debian-bullseye/>`__
to learn how you can install/upgrade to the new version.
.. include:: _includes/linux-preamble.rst
-------------------------------
Installing the pre-requirements
-------------------------------
We recommend installing pyenv as a method of installing non-native versions of Python on
Raspberry Pi OS. This guide will tell you how. First, run the following commands:
.. cmake is necessary to be able to successfully build rapidfuzz.
.. prompt:: bash
sudo apt update
sudo apt -y install cmake make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-17-jre-headless nano
CXX=/usr/bin/g++
.. Include common instructions:
.. We should only build and install even versions of Python on Raspberry Pi OS as odd
.. versions are part of piwheels and can cause installs of pip packages that won't work.
.. include:: _includes/install-python310-pyenv.rst
.. include:: _includes/create-env-with-pyenv-virtualenv.rst
.. include:: _includes/install-and-setup-red-unix.rst

View File

@ -1,25 +1,27 @@
.. _install-raspberry-pi-os-11:
=============================================
Installing Red on Raspberry Pi OS 11 Bullseye
=============================================
======================================================
Installing Red on Raspberry Pi OS (Legacy) 11 Bullseye
======================================================
.. include:: _includes/supported-arch-aarch64+armv7l.rst
.. note::
This guide can only be used with Raspberry Pi OS 11 Bullseye,
it will not work with any older (e.g. Raspberry Pi OS 10 Buster)
or newer (e.g. Raspberry Pi OS 12 Bookworm) releases.
You can check your version of Raspberry Pi OS by running:
While we do provide support and install instructions for running Red
on Raspberry Pi OS (Legacy) 11 Bullseye, we highly recommend installing/upgrading to
the new version - Raspberry Pi OS 12 Bookworm.
If you're not sure what version you are using,
you can check your version of Raspberry Pi OS by running:
.. prompt:: bash
lsb_release -a
If you're not running Bullseye, you should read
`the post about Bullseye release from Raspberry Pi Foundation <https://www.raspberrypi.com/news/raspberry-pi-os-debian-bullseye/>`__
to learn how you can install/upgrade to the new version.
If you're running Bookworm already, read `install-raspberry-pi-os-12` document instead.
If you're using Bullseye, please consider performing a clean install of Bookworm if possible.
.. include:: _includes/linux-preamble.rst

View File

@ -0,0 +1,38 @@
.. _install-raspberry-pi-os-12:
=============================================
Installing Red on Raspberry Pi OS 12 Bookworm
=============================================
.. include:: _includes/supported-arch-aarch64+armv7l.rst
.. note::
This guide can only be used with Raspberry Pi OS 12 Bookworm,
it will not work with any older (e.g. Raspberry Pi OS 11 Bullseye)
or newer (e.g. Raspberry Pi OS 13 Trixie) releases.
You can check your version of Raspberry Pi OS by running:
.. prompt:: bash
lsb_release -a
.. include:: _includes/linux-preamble.rst
-------------------------------
Installing the pre-requirements
-------------------------------
Raspberry Pi OS "Bookworm" has all required packages available in official repositories. Install them
with apt:
.. prompt:: bash
sudo apt update
sudo apt -y install python3 python3-dev python3-venv git openjdk-17-jre-headless build-essential nano
.. Include common instructions:
.. include:: _includes/create-env-with-venv3.11.rst
.. include:: _includes/install-and-setup-red-unix.rst

View File

@ -52,9 +52,9 @@ Operating system version Supported architectures Ideally supported u
================================ ======================= ============================================================
Windows 10 x86-64 `End/Retirement Date <https://docs.microsoft.com/en-us/lifecycle/products/windows-10-home-and-pro>`__
Windows 11 x86-64 `Retirement Date <https://docs.microsoft.com/en-us/lifecycle/products/windows-11-home-and-pro-version-21h2>`__
macOS 11 (Big Sur) x86-64, aarch64 ~2023-10
macOS 12 (Monterey) x86-64, aarch64 ~2024-10
macOS 13 (Ventura) x86-64, aarch64 ~2025-10
macOS 14 (Sonoma) x86-64, aarch64 ~2026-10
Alma Linux 8 x86-64, aarch64 2029-05-31 (`How long will CloudLinux support AlmaLinux? <https://wiki.almalinux.org/FAQ.html#how-long-will-almalinux-be-supported>`__)
Alma Linux 9 x86-64, aarch64 2032-05-31
Arch Linux x86-64 forever (support is only provided for an up-to-date system)
@ -63,15 +63,14 @@ CentOS Stream 8 x86-64, aarch64 2024-05-31 (`end of
CentOS Stream 9 x86-64, aarch64 2027-05-31 (`expected EOL <https://centos.org/stream9/#timeline>`__)
Debian 11 Bullseye x86-64, aarch64, armv7l ~2024-07 (`End of life <https://wiki.debian.org/DebianReleases#Production_Releases>`__)
Debian 12 Bookworm x86-64, aarch64, armv7l ~2026-09 (`End of life <https://wiki.debian.org/DebianReleases#Production_Releases>`__)
Fedora Linux 37 x86-64, aarch64 2023-11-14 (`End of Life <https://docs.fedoraproject.org/en-US/releases/lifecycle/#_maintenance_schedule>`__)
Fedora Linux 38 x86-64, aarch64 2024-05-14 (`End of Life <https://docs.fedoraproject.org/en-US/releases/lifecycle/#_maintenance_schedule>`__)
openSUSE Leap 15.4 x86-64, aarch64 2023-11-30 (`end of maintenance life cycle <https://en.opensuse.org/Lifetime#openSUSE_Leap>`__)
Fedora Linux 39 x86-64, aarch64 2024-11-12 (`End of Life <https://docs.fedoraproject.org/en-US/releases/lifecycle/#_maintenance_schedule>`__)
openSUSE Leap 15.5 x86-64, aarch64 2024-12-31 (`end of maintenance life cycle <https://en.opensuse.org/Lifetime#openSUSE_Leap>`__)
openSUSE Tumbleweed x86-64, aarch64 forever (support is only provided for an up-to-date system)
Oracle Linux 8 x86-64, aarch64 2029-07-31 (`End of Premier Support <https://www.oracle.com/us/support/library/elsp-lifetime-069338.pdf>`__)
Oracle Linux 9 x86-64, aarch64 2032-06-31 (`End of Premier Support <https://www.oracle.com/us/support/library/elsp-lifetime-069338.pdf>`__)
Raspberry Pi OS (Legacy) 10 armv7l ~2023-12 (approximate date of release of Raspberry Pi OS 12)
Raspberry Pi OS 11 aarch64, armv7l ~2023-12 (approximate date of release of Raspberry Pi OS 12)
Raspberry Pi OS (Legacy) 11 armv7l ~2025-10 (approximate date of release of Raspberry Pi OS 13)
Raspberry Pi OS 12 aarch64, armv7l ~2025-10 (approximate date of release of Raspberry Pi OS 13)
RHEL 8 (latest) x86-64, aarch64 2029-05-31 (`End of Maintenance Support <https://access.redhat.com/support/policy/updates/errata#Life_Cycle_Dates>`__)
RHEL 8.6 x86-64, aarch64 2024-05-31 (`End of Extended Update Support <https://access.redhat.com/support/policy/updates/errata#Extended_Update_Support>`__)
RHEL 8.8 x86-64, aarch64 2025-05-31 (`End of Extended Update Support <https://access.redhat.com/support/policy/updates/errata#Extended_Update_Support>`__)
@ -82,8 +81,7 @@ Rocky Linux 8 x86-64, aarch64 2029-05-31 (`end-of
Rocky Linux 9 x86-64, aarch64 2032-05-31 (`end-of-life <https://rockylinux.org/download/>`__)
Ubuntu 20.04 LTS x86-64, aarch64 2025-04-30 (`End of Standard Support <https://wiki.ubuntu.com/Releases#Current>`__)
Ubuntu 22.04 LTS x86-64, aarch64 2027-04-30 (`End of Standard Support <https://wiki.ubuntu.com/Releases#Current>`__)
Ubuntu 22.10 x86-64, aarch64 2023-07-31 (`End of Standard Support <https://wiki.ubuntu.com/Releases#Current>`__)
Ubuntu 23.04 x86-64, aarch64 2024-01-31 (`End of Standard Support <https://wiki.ubuntu.com/Releases#Current>`__)
Ubuntu 23.10 x86-64, aarch64 2024-07-31 (`End of Standard Support <https://wiki.ubuntu.com/Releases#Current>`__)
================================ ======================= ============================================================
.. _developer-guarantees: