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

Update documentation

Browse Source
This commit is contained in:
ReenigneArcher
2022-06-15 15:52:38 -04:00
parent 9990b9b04b
commit ca21e6a8ac
8 changed files with 80 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -23,25 +23,6 @@ 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
@@ -101,12 +82,7 @@ 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:
Portfile
#. Install `MacPorts <https://www.macports.org>`_
#. Update the Macports sources.
@@ -131,17 +107,6 @@ Portfile option:
sudo port install sunshine
#. The first time you start Sunshine, you will be asked to grant access to screen recording and your microphone.
#. Try to run the following code if you get this error: `Dynamic session lookup supported but failed: launchd did
not provide a socket path, verify that org.freedesktop.dbus-session.plist is loaded!`
.. code-block:: bash
launchctl load -w /Library/LaunchAgents/org.freedesktop.dbus-session.plist
Standalone option:
#. Download and extract ``sunshine-macos.zip``
.. Warning:: The Standalone package is experimental. Limited support will be provided.
Windows
-------

41
docs/source/about/usage.rst
View File

@@ -56,33 +56,26 @@ Setup
Linux
^^^^^
The deb and rpm packages handle these steps automatically. The AppImage does not, and third party packages may not as
well.
The deb and rpm packages handle these steps automatically. The AppImage does not, third party packages may not as well.
Sunshine needs access to `uinput` to create mouse and gamepad events.
Add user to group `input`.
Add user to group `input`, if this is the first time installing.
.. code-block:: bash
usermod -a -G input $USER
.. Warning:: If the above doesn't work you can try the following. This is not an advised method as it makes the
current user the owner of ``/dev/uinput``. Use at your own risk.
.. code-block:: bash
sudo chown $USER /dev/uinput
sudo usermod -a -G input $USER
sudo reboot now
Create `udev` rules.
.. code-block:: bash
nano /etc/udev/rules.d/85-sunshine-input.rules
sudo nano /etc/udev/rules.d/85-sunshine-input.rules
Input the following contents.
.. code-block::
KERNEL=="uinput", GROUP="input", MODE="0660", OPTION+="static_node=uinput"
KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"
Save the file and exit:
@@ -99,11 +92,22 @@ Configure autostart service
Description=Sunshine Gamestream Server for Moonlight
[Service]
ExecStart=~/sunshine.AppImage
ExecStart=<see table>
[Install]
WantedBy=graphical-session.target
.. table::
:widths: auto
======== =================== ===============
package ExecStart Auto Configured
======== =================== ===============
deb /usr/bin/sunshine ✔
rpm /usr/bin/sunshine ✔
AppImage ~/sunshine.AppImage ✖
======== =================== ===============
Start once
.. code-block:: bash
@@ -137,7 +141,14 @@ select their sink as audio device in `sunshine.conf`.
.. Note:: Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key.
.. Caution:: Gamepads are not supported.
.. Caution:: Gamepads are not currently supported.
Configure autostart service
MacPorts
.. code-block:: bash
sudo port load Sunshine
Windows
^^^^^^^