Update documentation
- Add copy button to code blocks - Fix some badges - Improve Linux installation instructions
This commit is contained in:
@@ -23,8 +23,9 @@ Usage
|
||||
Add games and applications.
|
||||
This can be configured in the web ui.
|
||||
|
||||
.. Note:: Additionally, apps can be configured manually. `assets/apps_<os>.json` is an example of a list of
|
||||
applications that are started just before running a stream.
|
||||
.. Note:: Additionally, apps can be configured manually. `src_assets/<os>/config/apps.json` is an example of a
|
||||
list of applications that are started just before running a stream. This is the directory within the GitHub
|
||||
repo.
|
||||
|
||||
.. Attention:: Application list is not fully supported on MacOS
|
||||
|
||||
@@ -55,6 +56,9 @@ Setup
|
||||
|
||||
Linux
|
||||
^^^^^
|
||||
The deb and rpm packages handle these steps automatically. The AppImage does not, and third party packages may not as
|
||||
well.
|
||||
|
||||
Sunshine needs access to `uinput` to create mouse and gamepad events.
|
||||
|
||||
Add user to group `input`.
|
||||
@@ -62,13 +66,23 @@ Add user to group `input`.
|
||||
|
||||
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
|
||||
|
||||
Create `udev` rules.
|
||||
.. code-block:: bash
|
||||
|
||||
nano /etc/udev/rules.d/85-sunshine-input.rules
|
||||
|
||||
Input the following contents:
|
||||
``KERNEL=="uinput", GROUP="input", MODE="0660"``
|
||||
Input the following contents.
|
||||
|
||||
.. code-block::
|
||||
|
||||
KERNEL=="uinput", GROUP="input", MODE="0660", OPTION+="static_node=uinput"
|
||||
|
||||
Save the file and exit:
|
||||
|
||||
@@ -76,18 +90,43 @@ Create `udev` rules.
|
||||
#. ``Y`` to save modifications.
|
||||
|
||||
Configure autostart service
|
||||
`path/to/build/dir/sunshine.service` is used to start sunshine in the background. To use it, do the following:
|
||||
- filename: ``~/.config/systemd/user/sunshine.service``
|
||||
- contents:
|
||||
|
||||
#. Copy it to the users systemd: ``cp sunshine.service ~/.config/systemd/user/``
|
||||
#. Starting
|
||||
.. code-block::
|
||||
|
||||
- One time: ``systemctl --user start sunshine``
|
||||
- Always on boot: ``systemctl --user enable sunshine``
|
||||
[Unit]
|
||||
Description=Sunshine Gamestream Server for Moonlight
|
||||
|
||||
[Service]
|
||||
ExecStart=~/sunshine.AppImage
|
||||
|
||||
[Install]
|
||||
WantedBy=graphical-session.target
|
||||
|
||||
Start once
|
||||
.. code-block:: bash
|
||||
|
||||
systemctl --user start sunshine
|
||||
|
||||
Start on boot
|
||||
.. code-block:: bash
|
||||
|
||||
systemctl --user enable sunshine
|
||||
|
||||
Additional Setup for KMS
|
||||
.. Note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it.
|
||||
.. Note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it. It is necessary to
|
||||
allow Sunshine to use KMS.
|
||||
|
||||
It is necessary to allow Sunshine to use KMS: ``sudo setcap cap_sys_admin+p sunshine``
|
||||
Enable
|
||||
.. code-block:: bash
|
||||
|
||||
sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine))
|
||||
|
||||
Disable
|
||||
.. code-block:: bash
|
||||
|
||||
sudo setcap -r $(readlink -f $(which sunshine))
|
||||
|
||||
MacOS
|
||||
^^^^^
|
||||
@@ -114,7 +153,7 @@ All shortcuts start with CTRL + ALT + SHIFT, just like Moonlight
|
||||
Application List
|
||||
----------------
|
||||
- You can use Environment variables in place of values
|
||||
- ``$(HOME)` will be replaced by the value of ``$HOME``
|
||||
- ``$(HOME)`` will be replaced by the value of ``$HOME``
|
||||
- ``$$`` will be replaced by ``$``, e.g. ``$$(HOME)`` will be replaced by ``$(HOME)``
|
||||
- ``env`` - Adds or overwrites Environment variables for the commands/applications run by Sunshine
|
||||
- ``"Variable name":"Variable value"``
|
||||
|
||||
Reference in New Issue
Block a user