Skip to content

docs: add linux ssh example #1388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReenigneArcher merged 1 commit into from
Jun 23, 2023
Merged

docs: add linux ssh example #1388

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/source/about/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ Usage

.. Attention:: The configuration file specified will be created if it doesn't exist.

**Start Sunshine over SSH (Linux/X11)**
.. code-block:: bash

ssh -t <user>@<ip_address> 'startx &; export DISPLAY=:0; sunshine'

.. Note:: You could also utilize the ``~/.bash_profile`` or ``~/.bashrc`` files to setup the ``DISPLAY``
variable.

#. Configure Sunshine in the web ui

The web ui is available on `https://localhost:47990 <https://localhost:47990>`_ by default. You may replace
Expand Down