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

Update documentation for Flatpak

Browse Source
This commit is contained in:
ReenigneArcher
2022-06-17 20:05:51 -04:00
parent 8509260194
commit 840013ec78
5 changed files with 93 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/CI.yml
+1 -1
View File
@@ -70,7 +70,7 @@ jobs:
- name: Cache flatpak-builder - name: Cache flatpak-builder
uses: actions/cache@v3 uses: actions/cache@v3
with: with:
path: ./build/.flatpak-builder path: ./build/.flatpak-builder/build
key: ${{ runner.os }}-flatpak-builder key: ${{ runner.os }}-flatpak-builder
- name: Checkout - name: Checkout
README.rst
+1
View File
@@ -2,6 +2,7 @@
Overview Overview
======== ========
SunshineStream has the full documentation hosted on `Read the Docs <http://sunshinestream.readthedocs.io/>`_.
About About
----- -----
docs/source/about/installation.rst
+28 -8
View File
@@ -28,7 +28,7 @@ AppImage
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:appimage?logo=github&style=for-the-badge .. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:appimage?logo=github&style=for-the-badge
:alt: GitHub issues by-label :alt: GitHub issues by-label
The current known compatibility of the AppImage is shown below. According to AppImageLint the AppImage can run on the following distros.
- [✖] Debian oldstable (buster) - [✖] Debian oldstable (buster)
- [✔] Debian stable (bullseye) - [✔] Debian stable (bullseye)
@@ -42,11 +42,11 @@ The current known compatibility of the AppImage is shown below.
- [✖] Ubuntu trusty - [✖] Ubuntu trusty
- [✖] CentOS 7 - [✖] CentOS 7
#. Download and extract ``sunshine-appimage.zip`` to your home directory. #. Download ``sunshine-appimage.zip`` and extract the contents to your home directory.
Debian Packages Debian Package
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:debian?logo=github&style=for-the-badge .. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:deb?logo=github&style=for-the-badge
:alt: GitHub issues by-label :alt: GitHub issues by-label
#. Download ``sunshine.deb`` and run the following code. #. Download ``sunshine.deb`` and run the following code.
@@ -57,9 +57,29 @@ Debian Packages
.. Tip:: You can double click the deb file to see details about the package and begin installation. .. Tip:: You can double click the deb file to see details about the package and begin installation.
Red Hat Packages Flatpak Package
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:fedora?logo=github&style=for-the-badge .. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:flatpak?logo=github&style=for-the-badge
:alt: GitHub issues by-label
.. Todo:: This package needs to have CUDA added.
#. Install `Flatpak <https://flatpak.org/setup/>`_ as required.
#. Download ``sunshine.flatpak`` and run the following code.
System level (recommended)
.. code-block:: bash
flatpak install --system sunshine.flatpak
User level
.. code-block:: bash
flatpak install --user sunshine.flatpak
RPM Package
^^^^^^^^^^^
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:rpm?logo=github&style=for-the-badge
:alt: GitHub issues by-label :alt: GitHub issues by-label
#. Add `rpmfusion` repositories by running the following code. #. Add `rpmfusion` repositories by running the following code.
docs/source/about/usage.rst
+63 -58
View File
@@ -33,7 +33,7 @@ Usage
#. When Moonlight request you insert the correct pin on sunshine: #. When Moonlight request you insert the correct pin on sunshine:
- Login to the web ui - Login to the web ui
- Go to "PIN" in the Header - Go to "PIN" in the Navbar
- Type in your PIN and press Enter, you should get a Success Message - Type in your PIN and press Enter, you should get a Success Message
- In Moonlight, select one of the Applications listed - In Moonlight, select one of the Applications listed
@@ -60,77 +60,82 @@ The deb and rpm packages handle these steps automatically. The AppImage does not
Sunshine needs access to `uinput` to create mouse and gamepad events. Sunshine needs access to `uinput` to create mouse and gamepad events.
Add user to group `input`, if this is the first time installing. #. Add user to group `input`, if this is the first time installing.
.. code-block:: bash .. code-block:: bash
sudo usermod -a -G input $USER sudo usermod -a -G input $USER
sudo reboot now
Create `udev` rules. #. Create `udev` rules.
.. code-block:: bash .. code-block:: bash
sudo nano /etc/udev/rules.d/85-sunshine-input.rules sudo nano /etc/udev/rules.d/85-sunshine-input.rules
Input the following contents. Input the following contents.
.. code-block::
KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"
Save the file and exit:
#. ``CTRL+X`` to start exit.
#. ``Y`` to save modifications.
Configure autostart service
- filename: ``~/.config/systemd/user/sunshine.service``
- contents:
.. code-block:: .. code-block::
[Unit] KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"
Description=Sunshine Gamestream Server for Moonlight
[Service] Save the file and exit:
ExecStart=<see table>
[Install] #. ``CTRL+X`` to start exit.
WantedBy=graphical-session.target #. ``Y`` to save modifications.
.. table:: #. Optionally, configure autostart service
:widths: auto - filename: ``~/.config/systemd/user/sunshine.service``
- contents:
======== =================== =============== .. code-block::
package ExecStart Auto Configured
======== =================== ===============
deb /usr/bin/sunshine ✔
rpm /usr/bin/sunshine ✔
AppImage ~/sunshine.AppImage ✖
======== =================== ===============
Start once [Unit]
Description=Sunshine Gamestream Server for Moonlight
[Service]
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 ✖
Flatpak flatpak run com.github.sunshinestream.sunshine ✖
======== ============================================== ===============
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. It is necessary to
allow Sunshine to use KMS.
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))
#. Reboot
.. code-block:: bash .. code-block:: bash
systemctl --user start sunshine sudo reboot now
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. It is necessary to
allow Sunshine to use KMS.
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 MacOS
^^^^^ ^^^^^
docs/source/index.rst
-2
View File
@@ -1,7 +1,5 @@
:github_url: https://github.com/SunshineStream/Sunshine/tree/nightly/docs/source/index.rst :github_url: https://github.com/SunshineStream/Sunshine/tree/nightly/docs/source/index.rst
SunshineStream has this documentation hosted on `Read the Docs <http://sunshinestream.readthedocs.io/>`_.
Table of Contents Table of Contents
================= =================
.. include:: toc.rst .. include:: toc.rst