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
|
.. _install:
.. |br| raw:: html
<br />
Installation
============
Linux and BSD packages
----------------------
.. rst-class:: table-custom-layout
==================================== ===========================================
Distribution Installing
==================================== ===========================================
`Arch Linux`_ .. code-block:: console
# pacman -S streamlink
`Arch Linux (aur, git)`_ .. code-block:: console
# pacaur -S streamlink-git
`Installing AUR packages`_
`Debian (sid, testing)`_ .. code-block:: console
# apt update
# apt install streamlink
`Debian (stable)`_ .. code-block:: console
# wget -qO- "https://bintray.com/user/downloadSubjectPublicKey?username=amurzeau" | apt-key add -
# echo "deb https://dl.bintray.com/amurzeau/streamlink-debian stretch-backports main" | tee "/etc/apt/sources.list.d/streamlink.list"
# apt update
# apt install streamlink
`Fedora`_ .. code-block:: console
# dnf install streamlink
`Gentoo Linux`_ .. code-block:: console
# emerge net-misc/streamlink
`NetBSD (pkgsrc)`_ .. code-block:: console
$ cd /usr/pkgsrc/multimedia/streamlink
# make install clean
`NixOS`_ .. code-block:: console
$ nix-env -iA nixos.streamlink
`NixOS channel`_
`Solus`_ .. code-block:: console
$ sudo eopkg install streamlink
`Ubuntu`_ .. code-block:: console
$ sudo add-apt-repository ppa:nilarimogard/webupd8
$ sudo apt update
$ sudo apt install streamlink
`Void`_ .. code-block:: console
# xbps-install streamlink
==================================== ===========================================
.. _Arch Linux: https://www.archlinux.org/packages/community/any/streamlink/
.. _Arch Linux (aur, git): https://aur.archlinux.org/packages/streamlink-git/
.. _Debian (sid, testing): https://packages.debian.org/unstable/streamlink
.. _Debian (stable): https://bintray.com/amurzeau/streamlink-debian/streamlink
.. _Fedora: https://apps.fedoraproject.org/packages/python-streamlink
.. _Gentoo Linux: https://packages.gentoo.org/package/net-misc/streamlink
.. _NetBSD (pkgsrc): http://pkgsrc.se/multimedia/streamlink
.. _NixOS: https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/video/streamlink
.. _Solus: https://dev.solus-project.com/source/streamlink/
.. _Ubuntu: http://ppa.launchpad.net/nilarimogard/webupd8/ubuntu/pool/main/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_packages
.. _NixOS channel: https://nixos.org/nixos/packages.html#streamlink
Other platforms
---------------
.. rst-class:: table-custom-layout
==================================== ===========================================
Platform Installing
==================================== ===========================================
Mac OS X .. code-block:: console
# easy_install -U streamlink
`Homebrew`_ .. code-block:: console
# brew install streamlink
`Installing Homebrew packages`_
Microsoft Windows See `Windows binaries`_ and `Windows portable version`_.
`Chocolatey`_ .. code-block:: console
C:\> choco install streamlink
`Installing Chocolatey packages`_
==================================== ===========================================
.. _Homebrew: https://github.com/Homebrew/homebrew-core/blob/master/Formula/streamlink.rb
.. _Chocolatey: https://chocolatey.org/packages/streamlink
.. _Installing Homebrew packages: https://brew.sh
.. _Installing Chocolatey packages: https://chocolatey.org
Package maintainers
-------------------
.. rst-class:: table-custom-layout
==================================== ===========================================
Distribution/Platform Maintainer
==================================== ===========================================
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>
Gentoo soredake <fdsfgs at krutt.org>
NetBSD Maya Rashish <maya at netbsd.org>
NixOS Tuomas Tynkkynen <tuomas.tynkkynen at iki.fi>
Solus Bryan T. Meyers <bmeyers at datadrake.com>
Ubuntu Alin Andrei <andrew at webupd8.org>
Void wkuipers <wietse at kuiprs.nl>
Windows binaries beardypig <beardypig at protonmail.com>
Windows port. version RosadinTV <RosadinTV at outlook.com> |br|
beardypig <beardypig at protonmail.com>
==================================== ===========================================
Source code
-----------
If a package is not available for your platform (or it's out of date) you
can install Streamlink via source.
There are a few different methods to do this,
`pip <http://pip.readthedocs.org/en/latest/installing.html>`_ the Python package
manager, or by checking out the latest code with
`Git <http://git-scm.com/downloads>`_. Using :command:`easy_install` is no longer recommended.
.. note::
For some Linux distributions the Python headers package needs to be installed before installing streamlink
(``python-devel`` in RedHat, Fedora, etc.).
Ensure that you are using an up-to-date version of :command:`pip`, at least version **6** is recommended.
The commands listed here will also upgrade any existing version of Streamlink.
.. rst-class:: table-custom-layout
==================================== ===========================================
Version Installing
==================================== ===========================================
`Latest release (pip)`_ .. code-block:: console
# pip install -U streamlink
`Latest release (easy_install)`_ .. code-block:: console
# easy_install -U streamlink
`Development version (pip)`_ .. code-block:: console
# pip install -U git+https://github.com/streamlink/streamlink.git
`Development version (git)`_ .. code-block:: console
$ git clone git://github.com/streamlink/streamlink.git
$ cd streamlink
# python setup.py install
==================================== ===========================================
.. _Latest release (pip): https://pypi.python.org/pypi/streamlink
.. _Latest release (easy_install): https://pypi.python.org/pypi/streamlink
.. _Development version (pip): https://github.com/streamlink/streamlink
.. _Development version (git): https://github.com/streamlink/streamlink
Dependencies
^^^^^^^^^^^^
To install Streamlink from source you will need these dependencies.
.. rst-class:: table-custom-layout
==================================== ===========================================
Name Notes
==================================== ===========================================
`Python`_ At least version **2.7** or **3.4**.
`python-setuptools`_
**Automatically installed by the setup script**
--------------------------------------------------------------------------------
`python-argparse`_ Only needed on Python versions older than **2.7**.
`python-futures`_ Only needed on Python **2.x**.
`python-requests`_ At least version **1.0**.
`python-singledispatch`_ Only needed on Python versions older than **3.4**.
`pycryptodome`_ Required to play some encrypted streams
`iso-639`_ Used for localization settings, provides language information
`iso3166`_ Used for localization settings, provides country information
`isodate`_ Used for MPEG-DASH streams
`PySocks`_ Used for SOCKS Proxies
`websocket-client`_ Used for some plugins
`shutil_get_terminal_size`_ Only needed on Python versions older than **3.3**
`shutil_which`_ Only needed on Python versions older than **3.3**
**Optional**
--------------------------------------------------------------------------------
`RTMPDump`_ Required to play RTMP streams.
`ffmpeg`_ Required to play streams that are made up of separate
audio and video streams, eg. YouTube 1080p+
==================================== ===========================================
Using pycrypto and pycountry
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
With these two environment variables it is possible to use `pycrypto`_ instead of
`pycryptodome`_ and `pycountry`_ instead of `iso-639`_ and `iso3166`_.
.. code-block:: console
$ export STREAMLINK_USE_PYCRYPTO="true"
$ export STREAMLINK_USE_PYCOUNTRY="true"
.. _Python: https://www.python.org/
.. _python-setuptools: https://pypi.org/project/setuptools/
.. _python-argparse: https://pypi.org/project/argparse/
.. _python-futures: https://pypi.org/project/futures/
.. _python-requests: http://python-requests.org/
.. _python-singledispatch: https://pypi.org/project/singledispatch/
.. _RTMPDump: http://rtmpdump.mplayerhq.hu/
.. _pycountry: https://pypi.org/project/pycountry/
.. _pycrypto: https://www.dlitz.net/software/pycrypto/
.. _pycryptodome: https://pycryptodome.readthedocs.io/en/latest/
.. _ffmpeg: https://www.ffmpeg.org/
.. _iso-639: https://pypi.org/project/iso-639/
.. _iso3166: https://pypi.org/project/iso3166/
.. _isodate: https://pypi.org/project/isodate/
.. _PySocks: https://github.com/Anorov/PySocks
.. _websocket-client: https://pypi.org/project/websocket-client/
.. _shutil_get_terminal_size: https://pypi.org/project/backports.shutil_get_terminal_size/
.. _shutil_which: https://pypi.org/project/backports.shutil_which/
Installing without root permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you do not wish to install Streamlink globally on your system it's
recommended to use `virtualenv`_ to create a user owned Python environment
instead.
.. code-block:: console
Creating an environment
$ virtualenv ~/myenv
Activating the environment
$ source ~/myenv/bin/activate
Installing streamlink into the environment
(myenv)$ pip install streamlink
Using streamlink in the environment
(myenv)$ streamlink ...
Deactivating the environment
(myenv)$ deactivate
Using streamlink without activating the environment
$ ~/myenv/bin/streamlink ...
.. note::
This may also be required on some OS X versions that seems to have weird
permission issues.
.. _virtualenv: https://virtualenv.readthedocs.io/en/latest/
Windows binaries
----------------
.. important::
Windows XP is not supported. |br|
Windows Vista requires at least SP2 to be installed.
.. rst-class:: table-custom-layout
==================================== ====================================
Release Notes
==================================== ====================================
`Stable release`_ Download the installer from the `GitHub releases page`_.
`Development build`_ For testing purposes only! Updated once per day. |br|
Download the installer from `Bintray`_. |br|
See the `list of recent changes`_ since the last stable release.
==================================== ====================================
.. _Stable release:
.. _GitHub releases page: https://github.com/streamlink/streamlink/releases/latest
.. _Development build:
.. _Bintray: https://bintray.com/streamlink/streamlink-nightly/streamlink/_latestVersion/#files
.. _list of recent changes: https://bintray.com/streamlink/streamlink-nightly/streamlink/_latestVersion/#release
These installers contain:
- A compiled version of Streamlink that **does not require an existing Python
installation**
- `RTMPDump`_ for viewing RTMP streams
- `ffmpeg`_ for muxing streams
and perform the following tasks:
- Add Streamlink to the system's list of installed applications. |br|
An uninstaller will automatically be created during installation.
- Add Streamlink's installation directory to the system's ``PATH`` environment variable. |br|
This allows the user to run the ``streamlink`` command globally
from the command prompt or powershell without specifying its directory.
To build the installer on your own, ``NSIS`` and ``pynsist`` need to be installed.
Windows portable version
^^^^^^^^^^^^^^^^^^^^^^^^
.. rst-class:: table-custom-layout
==================================== ===========================================
Maintainer Links
==================================== ===========================================
RosadinTV `Latest precompiled stable release`__ |br|
`Latest builder`__ |br|
`More info`__
Beardypig `Latest precompiled stable release`__ |br|
`Latest builder`__ |br|
`More info`__
==================================== ===========================================
__ https://github.com/streamlink/streamlink-portable/releases/latest
__ https://github.com/streamlink/streamlink-portable/archive/master.zip
__ https://github.com/streamlink/streamlink-portable
__ https://github.com/beardypig/streamlink-portable/releases/latest
__ https://github.com/beardypig/streamlink-portable/archive/master.zip
__ https://github.com/beardypig/streamlink-portable
|
