1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
|
.. |br| raw:: html
<br />
Installation
============
.. sphinx-design currently doesn't support autosectionlabel, so set labels for the following sections explicitly
.. grid:: 4
:padding: 0
:class-container: installation-grid
.. grid-item-card::
:link: windows
:link-type: ref
:link-alt: Windows
:padding: 3
:text-align: center
:fab:`windows`
.. grid-item-card::
:link: macos
:link-type: ref
:link-alt: macOS
:padding: 3
:text-align: center
:fab:`apple`
.. grid-item-card::
:link: linux-and-bsd
:link-type: ref
:link-alt: Linux and BSD
:padding: 3
:text-align: center
:fab:`linux`
.. grid-item-card::
:link: pypi-package-and-source-code
:link-type: ref
:link-alt: PyPI package and source code
:padding: 3
:text-align: center
:fab:`python`
.. _windows:
Windows
-------
.. list-table::
:header-rows: 1
:class: table-custom-layout
* - Method
- Installing
* - :octicon:`verified` Installers
- See the `Windows binaries`_ section below
* - :octicon:`verified` Portable
- See the `Windows binaries`_ section below
* - :octicon:`verified` Preview builds
- See the `Windows binaries`_ section below
* - :octicon:`verified` Python pip
- See the `PyPI package and source code`_ section below
* - :octicon:`package` `Chocolatey`_
- .. code-block:: bat
choco install streamlink
`Installing Chocolatey packages`_
* - :octicon:`package-dependents` `Scoop`_
- .. code-block::
scoop bucket add extras
scoop install streamlink
`Installing Scoop packages`_
* - :octicon:`package-dependents` `Windows Package Manager`_
- .. code-block:: bat
winget install streamlink
`Installing Winget packages`_
.. _Chocolatey: https://chocolatey.org/packages/streamlink
.. _Scoop: https://scoop.sh/#/apps?q=streamlink&s=0&d=1&o=true
.. _Windows Package Manager: https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Streamlink/Streamlink
.. _Installing Chocolatey packages: https://chocolatey.org
.. _Installing Scoop packages: https://scoop.sh
.. _Installing Winget packages: https://docs.microsoft.com/en-us/windows/package-manager/
.. _macos:
macOS
-----
.. list-table::
:header-rows: 1
:class: table-custom-layout
* - Method
- Installing
* - :octicon:`verified` Python pip
- See the `PyPI package and source code`_ section below
* - :octicon:`package-dependents` `Homebrew`_
- .. code-block:: bash
brew install streamlink
`Installing Homebrew packages`_
.. _Homebrew: https://formulae.brew.sh/formula/streamlink
.. _Installing Homebrew packages: https://brew.sh
.. _linux-and-bsd:
Linux and BSD
-------------
.. list-table::
:header-rows: 1
:class: table-custom-layout
* - Method / Distribution
- Installing
* - :octicon:`verified` AppImage
- See the `Linux AppImages`_ section below
* - :octicon:`verified` AppImage preview builds
- See the `Linux AppImages`_ section below
* - :octicon:`verified` Python pip
- See the `PyPI package and source code`_ section below
* - :octicon:`package-dependents` `Alpine Linux (edge)`_
- .. code-block:: bash
sudo apk add streamlink
* - :octicon:`package-dependents` `ALT Linux (Sisyphus)`_
- .. code-block:: bash
sudo apt-get install streamlink
* - :octicon:`package-dependents` `Arch Linux`_
- .. code-block:: bash
sudo pacman -S streamlink
* - :octicon:`package-dependents` `Arch Linux (aur, git)`_
- .. code-block:: bash
git clone https://aur.archlinux.org/streamlink-git.git
cd streamlink-git
makepkg -si
`Installing AUR packages`_
* - :octicon:`package-dependents` `Debian (sid, testing)`_
- .. code-block:: bash
sudo apt update
sudo apt install streamlink
* - :octicon:`package-dependents` `Debian (stable)`_
- .. code-block:: bash
# If you don't have Debian backports already (see link below):
echo "deb http://deb.debian.org/debian bookworm-backports main" | sudo tee "/etc/apt/sources.list.d/streamlink.list"
sudo apt update
sudo apt -t bookworm-backports install streamlink
`Installing Debian backported packages`_
* - :octicon:`package-dependents` `Fedora`_
- .. code-block:: bash
sudo dnf install streamlink
* - :octicon:`package-dependents` `FreeBSD (pkg)`_
- .. code-block:: bash
pkg install multimedia/streamlink
* - :octicon:`package-dependents` `FreeBSD (ports)`_
- .. code-block:: bash
cd /usr/ports/multimedia/streamlink
make config install clean
* - :octicon:`package-dependents` `Gentoo Linux`_
- .. code-block:: bash
sudo emerge net-misc/streamlink
* - :octicon:`package-dependents` `NixOS`_
- .. code-block:: bash
nix-env -iA nixos.streamlink
`NixOS channel`_
* - :octicon:`package-dependents` `openSUSE`_
- .. code-block:: bash
sudo zypper install streamlink
* - :octicon:`package-dependents` `Ubuntu`_
- Not recommended.
Ubuntu inherits the ``streamlink`` package from Debian, but doesn't maintain or update it.
See `Package availability`_.
* - :octicon:`package-dependents` `Solus`_
- .. code-block:: bash
sudo eopkg install streamlink
* - :octicon:`package-dependents` `Void`_
- .. code-block:: bash
sudo xbps-install streamlink
.. _Alpine Linux (edge): https://pkgs.alpinelinux.org/packages?name=streamlink
.. _ALT Linux (Sisyphus): https://packages.altlinux.org/en/sisyphus/srpms/streamlink/
.. _Arch Linux: https://archlinux.org/packages/extra/any/streamlink/
.. _Arch Linux (aur, git): https://aur.archlinux.org/packages/streamlink-git/
.. _Debian (sid, testing): https://packages.debian.org/sid/streamlink
.. _Debian (stable): https://packages.debian.org/bookworm-backports/streamlink
.. _Fedora: https://src.fedoraproject.org/rpms/python-streamlink
.. _FreeBSD (pkg): https://ports.freebsd.org/cgi/ports.cgi?query=streamlink&stype=name
.. _FreeBSD (ports): https://www.freshports.org/multimedia/streamlink
.. _Gentoo Linux: https://packages.gentoo.org/package/net-misc/streamlink
.. _NixOS: https://github.com/NixOS/nixpkgs/tree/master/pkgs/by-name/st/streamlink
.. _openSUSE: https://build.opensuse.org/package/show/multimedia:apps/streamlink
.. _Ubuntu: https://packages.ubuntu.com/noble/streamlink
.. _Solus: https://github.com/getsolus/packages/tree/main/packages/s/streamlink
.. _Void: https://github.com/void-linux/void-packages/tree/master/srcpkgs/streamlink
.. _Installing AUR packages: https://wiki.archlinux.org/index.php/Arch_User_Repository
.. _Installing Debian backported packages: https://wiki.debian.org/Backports
.. _NixOS channel: https://search.nixos.org/packages?show=streamlink&query=streamlink
Package maintainers
-------------------
.. list-table::
:header-rows: 1
:class: table-custom-layout
* - Distribution / Platform
- Maintainer
* - Alpine Linux
- Hoang Nguyen <folliekazetani at protonmail.com>
* - ALT Linux
- Vitaly Lipatov <lav at altlinux.ru>
* - Arch
- Giancarlo Razzolini <grazzolini at archlinux.org>
* - Arch (aur, git)
- Josip Ponjavic <josipponjavic at gmail.com>
* - Chocolatey
- Scott Walters <me at scowalt.com>
* - Debian
- Alexis Murzeau <amubtdx at gmail.com>
* - Fedora
- Mohamed El Morabity <melmorabity at fedoraproject.org>
* - FreeBSD
- Takefu <takefu at airport.fm>
* - Gentoo
- soredake <fdsfgs at krutt.org>
* - NixOS
- Tuomas Tynkkynen <tuomas.tynkkynen at iki.fi>
* - openSUSE
- Simon Puchert <simonpuchert at alice.de>
* - Solus
- Joey Riches <josephriches at gmail.com>
* - Void
- Tom Strausbaugh <tstrausbaugh at straustech.net>
* - Windows binaries
- Sebastian Meyer <mail at bastimeyer.de>
* - Linux AppImages
- Sebastian Meyer <mail at bastimeyer.de>
Package availability
--------------------
Packaging is not done by the Streamlink maintainers themselves except for
the `PyPI package <pypi-package-and-source-code_>`_,
the `Windows installers + portable builds <Windows binaries_>`_,
and the `Linux AppImages <Linux AppImages_>`_.
If a packaged release of Streamlink is not available for your operating system / distro or your system's architecture,
or if it's out of date or broken, then please contact the respective package maintainers or package-repository maintainers
of your operating system / distro, as it's up to them to add, update, or fix those packages.
Users of glibc-based Linux distros can find up-to-date Streamlink releases via the available `AppImages <Linux AppImages_>`_.
Please open an issue or pull request on GitHub if an **available**, **maintained** and **up-to-date** package is missing
from the install docs.
.. _pypi-package-and-source-code:
PyPI package and source code
----------------------------
If a package is not available on your platform, or if it's out of date,
then Streamlink can be installed via `pip`_, the Python package manager.
.. warning::
On Linux, when not using a `virtual environment`_, it is recommended to **install custom python packages like this
only for the current user** using the ``--user`` parameter, since system-wide packages can cause conflicts with
the system's regular package manager. Never install Python packages via sudo in your system's global Python environment.
User-packages will be installed into ``~/.local`` instead of ``/usr``, and entry-scripts for
running the programs can be found in ``~/.local/bin``, e.g. ``~/.local/bin/streamlink``.
In order for the command line shell to be able to find these executables, the user's ``PATH`` environment variable
needs to be extended. This can be done by adding ``export PATH="${HOME}/.local/bin:${PATH}"``
to ``~/.profile`` or ``~/.bashrc``.
.. list-table::
:header-rows: 1
:class: table-custom-layout
* - Version
- Installing
* - :octicon:`verified` `Latest release`_
- .. code-block:: bash
pip install -U streamlink
* - :octicon:`verified` `Master branch`_
- .. code-block:: bash
pip install -U git+https://github.com/streamlink/streamlink.git
* - :octicon:`unverified` `From a pull request <pip-install-vcs_>`_
- .. code-block:: bash
pip install -U git+https://github.com/streamlink/streamlink.git@refs/pull/PULL-REQUEST-ID/head
* - :octicon:`unverified` `Specific tag/branch/commit <pip-install-vcs_>`_
- .. code-block:: bash
pip install -U git+https://github.com/USERNAME/streamlink.git@REVISION
.. _pip: https://pip.pypa.io/en/stable/
.. _Latest release: https://pypi.python.org/pypi/streamlink
.. _Master branch: https://github.com/streamlink/streamlink/commits/master
.. _pip-install-vcs: https://pip.pypa.io/en/stable/topics/vcs-support/#git
Virtual environment
-------------------
A better way of installing Streamlink as a non-system Python package is using the `venv`_ or `virtualenv`_ Python modules,
which both create a user-owned Python environment which is isolated from the system's main Python environment.
While `venv`_ is part of Python's standard library since ``3.3``, `virtualenv`_ is the project which `venv`_ originated from,
but it first needs to be installed, either via `pip`_ or from the system's package manager. It also implements more features,
so depending on your needs, you may want to use `virtualenv`_ instead of `venv`_.
Install using ``venv`` and ``pip``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
# Create a new environment
python -m venv ~/myenv
# Activate the environment
# note: non-POSIX compliant shells like FISH or PowerShell have different activation script file names
# note: on Windows, the `bin` subdirectory is called `Scripts`
source ~/myenv/bin/activate
# *Either* install the latest Streamlink release from PyPI in the virtual environment
pip install --upgrade streamlink
# *Or*, install the most up-to-date development version from master on GitHub
pip install --upgrade git+https://github.com/streamlink/streamlink.git
# Use Streamlink in the environment
streamlink ...
# Deactivate the environment
deactivate
# Use Streamlink without activating the environment
~/myenv/bin/streamlink ...
Install using ``pipx``
^^^^^^^^^^^^^^^^^^^^^^
The `pipx`_ project combines the functionality of both ``venv`` and ``pip``. It may be necessary to
install it first, either with a system package manager, or using ``pip``, as detailed in the `documentation <pipx_>`_.
.. code-block:: bash
# *Either* install the latest Streamlink release from PyPI in a virtual environment
pipx install streamlink
# *Or*, install the most up-to-date development version from master on GitHub
pipx install git+https://github.com/streamlink/streamlink.git
# Use Streamlink
streamlink ...
.. _venv: https://docs.python.org/3/library/venv.html
.. _virtualenv: https://virtualenv.pypa.io/en/stable/
.. _pipx: https://pypa.github.io/pipx/
Source distribution
-------------------
In addition to the pre-built wheels uploaded to PyPI, Streamlink's source distribution tarballs get uploaded
to both PyPI and GitHub releases. These tarballs are meant for packagers and are signed using the following PGP key:
:bdg-link-primary-line:`44448A298D5C3618 <https://keyserver.ubuntu.com/pks/lookup?search=44448A298D5C3618&fingerprint=on&op=index>`
Please be aware that PyPI has dropped support for uploading new release file signatures in May 2023, so those can only be found
on `GitHub releases`_ now.
See the `Dependencies`_ section down below for the required build- and runtime-requirements.
.. warning::
Please avoid building Streamlink from tarballs generated by GitHub from (tagged) git commits,
as they are lacking the built-in release version string. The ``versioningit`` build-requirement also won't be able
to find the correct version, as the content is not part of a git repository.
Instead, build from Streamlink's signed source-distribution tarballs which are uploaded to PyPI and GitHub releases,
or from the cloned git repository.
.. _GitHub Releases: https://github.com/streamlink/streamlink/releases
Dependencies
^^^^^^^^^^^^
To install Streamlink from source, you will need these dependencies.
Since :ref:`4.0.0 <changelog:streamlink 4.0.0 (2022-05-01)>`,
Streamlink defines a `build system <pyproject.toml_>`__ according to `PEP-517`_ / `PEP-518`_.
.. list-table::
:header-rows: 1
:class: table-custom-layout table-custom-layout-dependencies
* - Type
- Name
- Notes
* - python
- `Python`_
- At least version **3.9**
* - build
- `setuptools`_
- At least version **65.6.0** |br|
Used as build backend
* - build
- `wheel`_
- Used by the build frontend for creating Python wheels
* - build
- `versioningit`_
- At least version **2.0.0** |br|
Used for generating the version string from git when building, or when running in an editable install.
Not needed when building wheels and installing from the source distribution.
* - runtime
- `certifi`_
- Used for loading the CA bundle extracted from the Mozilla Included CA Certificate List
* - runtime
- `exceptiongroup`_
- Only required when ``python_version<"3.11"`` |br|
Used for ``ExceptionGroup`` handling
* - runtime
- `isodate`_
- Used for parsing ISO8601 strings
* - runtime
- `lxml`_
- Used for processing HTML and XML data
* - runtime
- `pycountry`_
- Used for localization settings, provides country and language data
* - runtime
- `pycryptodome`_
- Used for decrypting encrypted streams
* - runtime
- `PySocks`_
- Used for SOCKS Proxies
* - runtime
- `requests`_
- Used for making any kind of HTTP/HTTPS request
* - runtime
- `trio`_
- Used for async concurrency and I/O in some parts of Streamlink
* - runtime
- `trio-websocket`_
- Used for WebSocket connections on top of the async trio framework
* - runtime
- `urllib3`_
- Used internally by `requests`_, defined as direct dependency
* - runtime
- `websocket-client`_
- Used for making websocket connections
* - optional
- `FFmpeg`_
- Required for `muxing`_ multiple video/audio/subtitle streams into a single output stream.
- DASH streams with video and audio content always have to get remuxed.
- HLS streams optionally need to get remuxed depending on the stream selection.
* - optional
- | `brotli`_
| ``decompress`` extras marker
- Used for decompressing HTTP responses
* - optional
- | `zstandard`_
| ``decompress`` extras marker
- Used for decompressing HTTP responses
.. _pyproject.toml: https://github.com/streamlink/streamlink/blob/master/pyproject.toml
.. _PEP-517: https://peps.python.org/pep-0517/
.. _PEP-518: https://peps.python.org/pep-0518/
.. _Python: https://www.python.org/
.. _setuptools: https://setuptools.pypa.io/en/latest/
.. _wheel: https://wheel.readthedocs.io/en/stable/
.. _versioningit: https://versioningit.readthedocs.io/en/stable/
.. _certifi: https://certifiio.readthedocs.io/en/latest/
.. _exceptiongroup: https://github.com/agronholm/exceptiongroup
.. _isodate: https://pypi.org/project/isodate/
.. _lxml: https://lxml.de/
.. _pycountry: https://pypi.org/project/pycountry/
.. _pycryptodome: https://pycryptodome.readthedocs.io/en/latest/
.. _PySocks: https://github.com/Anorov/PySocks
.. _requests: https://requests.readthedocs.io/en/latest/
.. _trio: https://trio.readthedocs.io/en/stable/
.. _trio-websocket: https://trio-websocket.readthedocs.io/en/stable/
.. _urllib3: https://urllib3.readthedocs.io/en/stable/
.. _websocket-client: https://pypi.org/project/websocket-client/
.. _brotli: https://pypi.org/project/Brotli/
.. _zstandard: https://pypi.org/project/zstandard/
.. _FFmpeg: https://www.ffmpeg.org/
.. _muxing: https://en.wikipedia.org/wiki/Multiplexing#Video_processing
Windows binaries
----------------
.. grid:: 2
:padding: 0
:class-container: grid-with-icons
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/windows-builds/releases
:link-alt: Windows stable releases
:text-align: center
**Windows stable releases**
^^^
:fas:`download;fa-2x` GitHub releases page
:fas:`check-circle;sd-text-success fa-lg` The most recent Streamlink release
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/windows-builds/actions/workflows/preview-build.yml
:link-alt: Windows preview builds
:text-align: center
**Windows preview builds**
^^^
:fas:`download;fa-2x` GitHub actions build artifacts
:fab:`github;fa-lg` Account required
**Flavors**
.. grid:: 2
:padding: 0
:class-container: grid-with-icons
.. grid-item-card::
:padding: 3
:class-header: sd-text-center
:class-body: sd-py-0
:class-footer: sd-text-center sd-bg-transparent sd-border-0 sd-pt-0 sd-pb-3
:fas:`gears` **Installer**
^^^
- Windows 10+
- Adds itself to the system's ``PATH`` env var
- Automatically creates a :ref:`config file <cli/config:Configuration file>`
- Sets :option:`--ffmpeg-ffmpeg` in config file
+++
:bdg-link-success-line:`x86_64 <https://github.com/streamlink/windows-builds/releases>`
.. grid-item-card::
:padding: 3
:class-header: sd-text-center
:class-body: sd-py-0
:class-footer: sd-text-center sd-bg-transparent sd-border-0 sd-pt-0 sd-pb-3
:fas:`file-zipper` **Portable archive**
^^^
- Windows 10+
- No :ref:`config file <cli/config:Configuration file>` created automatically
- :option:`--ffmpeg-ffmpeg` must be set manually
- No pre-compiled Python bytecode
+++
:bdg-link-success-line:`x86_64 <https://github.com/streamlink/windows-builds/releases>`
**Contents**
.. grid:: 3
:padding: 0
:class-container: grid-with-images
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/python-windows-embed
:link-alt: Embedded Python build
:text-align: center
.. image:: _static/icon-python.svg
:alt: Python
Python |br| :sub:`embedded build`
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/streamlink
:link-alt: Streamlink and its runtime dependencies
:text-align: center
.. image:: _static/icon.svg
:alt: Streamlink
Streamlink |br| :sub:`and dependencies`
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/FFmpeg-Builds
:link-alt: FFmpeg, required for muxing streams
:text-align: center
.. image:: _static/icon-ffmpeg.svg
:alt: FFmpeg
FFmpeg |br| :sub:`for muxing streams`
Linux AppImages
---------------
.. grid:: 2
:padding: 0
:class-container: grid-with-icons
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/streamlink-appimage/releases
:link-alt: AppImage stable releases
:text-align: center
**AppImage stable releases**
^^^
:fas:`download;fa-2x` GitHub releases page
:fas:`check-circle;sd-text-success fa-lg` The most recent Streamlink release
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/streamlink-appimage/actions/workflows/preview-build.yml
:link-alt: AppImage preview builds
:text-align: center
**AppImage preview builds**
^^^
:fas:`download;fa-2x` GitHub actions build artifacts
:fab:`github;fa-lg` Account required
**Architectures**
.. grid:: 2
:padding: 0
.. grid-item-card::
:padding: 3
:text-align: center
:bdg-link-success-line:`x86_64 <https://github.com/streamlink/streamlink-appimage/releases>`
.. grid-item-card::
:padding: 3
:text-align: center
:bdg-link-success-line:`aarch64 <https://github.com/streamlink/streamlink-appimage/releases>`
**Contents**
.. grid:: 3
:padding: 0
:class-container: grid-with-images
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/appimage-buildenv
:link-alt: Python from the pypa/manulinux docker images
:text-align: center
.. image:: _static/icon-python.svg
:alt: Python
Python |br| :sub:`from the pypa/manylinux docker images`
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/streamlink
:link-alt: Streamlink and its runtime dependencies
:text-align: center
.. image:: _static/icon.svg
:alt: Streamlink
Streamlink |br| :sub:`and dependencies`
.. grid-item-card::
:padding: 3
:link: https://github.com/streamlink/FFmpeg-Builds
:link-alt: FFmpeg, required for muxing streams
:text-align: center
.. image:: _static/icon-ffmpeg.svg
:alt: FFmpeg
FFmpeg |br| :sub:`for muxing streams` |br| :sub:`(optional)`
**How-To**
1. Verify that the system is running on at least
`glibc <glibc-wikipedia_>`_ `2.28 (Aug 2018) <glibc-release-distro-mapping_>`_ (see :command:`ld.so --version`)
2. Download the AppImage file matching the system's CPU architecture (see :command:`uname --machine`)
3. Set the executable flag via a file browser or :command:`chmod +x filename` from a command-line shell
.. code-block:: bash
# AppImage file names include the release version,
# the Python version, platform name and CPU architecture
chmod +x streamlink-7.0.0-1-cp312-cp312-manylinux_2_28_x86_64.AppImage
4. Run the AppImage with any command-line parameters supported by Streamlink
.. code-block:: bash
./streamlink-7.0.0-1-cp312-cp312-manylinux_2_28_x86_64.AppImage --loglevel=debug
.. _glibc-wikipedia: https://en.wikipedia.org/wiki/Glibc
.. _glibc-release-distro-mapping: https://sourceware.org/glibc/wiki/Release#Distribution_Branch_Mapping
What are AppImages?
^^^^^^^^^^^^^^^^^^^
AppImages are portable applications which are independent of the Linux distribution in use and its package management.
Just set the executable flag on the AppImage file and run it.
The only requirement is having `FUSE`_ installed for being able to mount the contents of the AppImage's SquashFS,
which is done automatically. Also, only glibc-based systems are currently supported.
Note: Check out `AppImageLauncher`_, which automates the setup and system
integration of AppImages. AppImageLauncher may also be available via your
distro's package management.
Additional information, like for example how to inspect the AppImage contents or
how to extract the contents if `FUSE`_ is not available on your system, can be
found in the `AppImage documentation`_.
.. _AppImageLauncher: https://github.com/TheAssassin/AppImageLauncher
.. _FUSE: https://docs.appimage.org/user-guide/troubleshooting/fuse.html
.. _AppImage documentation: https://docs.appimage.org/user-guide/run-appimages.html
.. _streamlink-master: https://github.com/streamlink/streamlink/commits/master
|