From 840013ec78bc670ca9d4b1b9da747a6f8265d671 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 17 Jun 2022 20:05:51 -0400 Subject: [PATCH] Update documentation for Flatpak --- .github/workflows/CI.yml | 2 +- README.rst | 1 + docs/source/about/installation.rst | 36 +++++++-- docs/source/about/usage.rst | 121 +++++++++++++++-------------- docs/source/index.rst | 2 - 5 files changed, 93 insertions(+), 69 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index b25b7353..2562d68d 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -70,7 +70,7 @@ jobs: - name: Cache flatpak-builder uses: actions/cache@v3 with: - path: ./build/.flatpak-builder + path: ./build/.flatpak-builder/build key: ${{ runner.os }}-flatpak-builder - name: Checkout diff --git a/README.rst b/README.rst index 8fb29b6b..24d0c161 100644 --- a/README.rst +++ b/README.rst @@ -2,6 +2,7 @@ Overview ======== +SunshineStream has the full documentation hosted on `Read the Docs `_. About ----- diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst index 2176206a..9973b820 100644 --- a/docs/source/about/installation.rst +++ b/docs/source/about/installation.rst @@ -28,7 +28,7 @@ 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. +According to AppImageLint the AppImage can run on the following distros. - [✖] Debian oldstable (buster) - [✔] Debian stable (bullseye) @@ -42,11 +42,11 @@ The current known compatibility of the AppImage is shown below. - [✖] Ubuntu trusty - [✖] 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 -^^^^^^^^^^^^^^^ -.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:debian?logo=github&style=for-the-badge +Debian Package +^^^^^^^^^^^^^^ +.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/pkg:deb?logo=github&style=for-the-badge :alt: GitHub issues by-label #. 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. -Red Hat Packages -^^^^^^^^^^^^^^^^ -.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:linux:fedora?logo=github&style=for-the-badge +Flatpak Package +^^^^^^^^^^^^^^^ +.. 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 `_ 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 #. Add `rpmfusion` repositories by running the following code. diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst index 79d285f9..8ae0287c 100644 --- a/docs/source/about/usage.rst +++ b/docs/source/about/usage.rst @@ -33,7 +33,7 @@ Usage #. When Moonlight request you insert the correct pin on sunshine: - 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 - 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. -Add user to group `input`, if this is the first time installing. - .. code-block:: bash +#. Add user to group `input`, if this is the first time installing. + .. code-block:: bash - sudo usermod -a -G input $USER - sudo reboot now + sudo usermod -a -G input $USER -Create `udev` rules. - .. code-block:: bash +#. Create `udev` rules. + .. 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. - - .. 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: + Input the following contents. .. code-block:: - [Unit] - Description=Sunshine Gamestream Server for Moonlight + KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput" - [Service] - ExecStart= + Save the file and exit: - [Install] - WantedBy=graphical-session.target + #. ``CTRL+X`` to start exit. + #. ``Y`` to save modifications. - .. table:: - :widths: auto +#. Optionally, configure autostart service + - filename: ``~/.config/systemd/user/sunshine.service`` + - contents: - ======== =================== =============== - package ExecStart Auto Configured - ======== =================== =============== - deb /usr/bin/sunshine ✔ - rpm /usr/bin/sunshine ✔ - AppImage ~/sunshine.AppImage ✖ - ======== =================== =============== + .. code-block:: - Start once + [Unit] + Description=Sunshine Gamestream Server for Moonlight + + [Service] + ExecStart= + + [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 - 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)) + sudo reboot now MacOS ^^^^^ diff --git a/docs/source/index.rst b/docs/source/index.rst index 5384c8e2..aaa2663c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,5 @@ :github_url: https://github.com/SunshineStream/Sunshine/tree/nightly/docs/source/index.rst -SunshineStream has this documentation hosted on `Read the Docs `_. - Table of Contents ================= .. include:: toc.rst