Sunshine/docs/source/about/installation.rst

:github_url: https://github.com/SunshineStream/Sunshine/tree/nightly/docs/source/about/installation.rst

Installation
============
The recommended method for running Sunshine is to use the `binaries`_ bundled with the `latest release`_.

Binaries
--------
Binaries of Sunshine are created for each release. They are available for Linux, and Windows.
Binaries can be found in the `latest release`_.

.. Todo:: Create binary package(s) for MacOS. See `here <https://github.com/SunshineStream/Sunshine/issues/61>`_.

.. Tip:: Some third party packages also exist. See
   :ref:`Third Party Packages <about/third_party_packages:third party packages>`.

Docker
------
.. Todo:: Docker images of Sunshine are planned to be included in the future.
   They will be available on `Dockerhub.io`_ and `ghcr.io`_.

Linux
-----
Follow the instructions for your preferred package type below.

.. Hint:: If this is the first time installing.

      .. code-block:: bash

         sudo usermod -a -G input $USER
         sudo reboot now

.. Tip:: Optionally, run Sunshine in the background.

      .. code-block:: bash

         systemctl --user start sunshine

.. Note:: If screencasting fails with Wayland, you may need to run the following to force screencasting with X11.

      .. code-block:: bash

         sudo setcap -r $(readlink -f $(which sunshine))

AppImage
^^^^^^^^
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:appimage?logo=github&style=for-the-badge
   :alt: GitHub issues by-label

The current known compatibility of the AppImage is shown below.

   - [✖] Debian oldstable (buster)
   - [✔] Debian stable (bullseye)
   - [✔] Debian testing (bookworm)
   - [✔] Debian unstable (sid)
   - [✔] Ubuntu jammy
   - [✔] Ubuntu impish
   - [✔] Ubuntu focal
   - [✖] Ubuntu bionic
   - [✖] Ubuntu xenial
   - [✖] Ubuntu trusty
   - [✖] CentOS 7

#. Download and extract ``sunshine-appimage.zip`` to your home directory.

Debian Packages
^^^^^^^^^^^^^^^
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:debian?logo=github&style=for-the-badge
   :alt: GitHub issues by-label

#. Download ``sunshine.deb`` and run the following code.

   .. code-block:: bash

      sudo apt install -f ./sunshine.deb

.. Tip:: You can double click the deb file to see details about the package and begin installation.

Red Hat Packages
^^^^^^^^^^^^^^^^
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:fedora?logo=github&style=for-the-badge
   :alt: GitHub issues by-label

#. Add `rpmfusion` repositories by running the following code.

   .. code-block:: bash

      sudo dnf install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm \
      https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm

#. Download ``sunshine.rpm`` and run the following code.

   .. code-block:: bash

      sudo dnf install ./sunshine.rpm

.. Tip:: You can double click the rpm file to see details about the package and begin installation.

MacOS
-----
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:macos?logo=github&style=for-the-badge
   :alt: GitHub issues by-label

Disk Image File option:
   #. Download and install ``sunshine.dmg``

   .. Warning:: The Disk Image File is experimental. Limited support will be provided.

Portfile option:
   #. Install `MacPorts <https://www.macports.org>`_
   #. Download the ``Portfile`` to ``/tmp`` and run the following code.

      .. code-block:: bash

         cd /tmp && sudo port install

   #. The first time you start Sunshine, you will be asked to grant access to screen recording and your microphone.

Standalone option:
   #. Download and extract ``sunshine-macos.zip``

   .. Warning:: The Standalone package is experimental. Limited support will be provided.

Windows
-------
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:windows:10?logo=github&style=for-the-badge
   :alt: GitHub issues by-label

.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:windows:11?logo=github&style=for-the-badge
   :alt: GitHub issues by-label

Installed option:
   #. Download and install ``sunshine-windows.exe``

Standalone option:
   #. Download and extract ``sunshine-windows.zip``

.. _latest release: https://github.com/SunshineStream/Sunshine/releases/latest
.. _Dockerhub.io: https://hub.docker.com/repository/docker/sunshinestream/sunshine
.. _ghcr.io: https://github.com/orgs/SunshineStream/packages?repo_name=sunshine