izackp/Apollo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
- Add copy button to code blocks
- Fix some badges
- Improve Linux installation instructions
This commit is contained in:
ReenigneArcher
2022-06-08 23:00:59 -04:00
parent 9b4fc8a270
commit 65c4f01998
6 changed files with 105 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/source/about/installation.rst
View File

@@ -21,6 +21,26 @@ Docker
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
^^^^^^^^
@@ -41,39 +61,40 @@ The current known compatibility of the AppImage is shown below.
- [✖] Ubuntu trusty
- [✖] CentOS 7
#. Download and extract `sunshine-appimage.zip`
#. Edit ``/etc/udev/rules.d/85-sunshine-rules.rules`` and add
``KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"``
#. 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``
#. ``sudo apt install -f ./sunshine.deb``
#. 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
#. Download ``sunshine.rpm``
#. ``sudo dnf install ./sunshine.rpm``
#. Add `rpmfusion` repositories by running the following code.
.. Hint:: If this is the first time installing.
.. code-block:: bash
.. 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
sudo usermod -a -G input $USER
sudo reboot now
#. Download ``sunshine.rpm`` and run the following code.
.. Tip:: Optionally, run Sunshine in the background.
.. code-block:: bash
.. code-block:: bash
sudo dnf install ./sunshine.rpm
systemctl --user start sunshine
.. Tip:: You can double click the rpm file to see details about the package and begin installation.
MacOS
-----
@@ -87,8 +108,12 @@ Disk Image File option:
Portfile option:
#. Install `MacPorts <https://www.macports.org>`_
#. Download the ``Portfile`` to ``/tmp``
#. In a terminal run ``cd /tmp && sudo port install``
#. 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: