Skip to content
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.

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

Documentation Update: Add linux ssh guide #1527

Merged
merged 105 commits into from
Sep 14, 2023

Conversation

e-dong
Copy link
Contributor

@e-dong e-dong commented Aug 13, 2023

Description

Added a guide to setup remote SSH into host to startup X server and sunshine without physical login to host and dummy plug. Note this guide is specific to Xorg and NVidida GPUs.

Screenshot

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

  • I want maintainers to keep my branch updated

@CLAassistant
Copy link

CLAassistant commented Aug 13, 2023

CLA assistant check
All committers have signed the CLA.

@ReenigneArcher

This comment was marked as outdated.

Copy link
Member

@ReenigneArcher ReenigneArcher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is draft, so consider this a preliminary review.

No need to create an issue. It's an optional field in the PR template.

Otherwise, looking forward to seeing what you come up with to help us improve our docs! Some things could definitely be organized better.

.gitignore Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/source/toc.rst Outdated Show resolved Hide resolved
@e-dong

This comment was marked as duplicate.

@e-dong
Copy link
Contributor Author

e-dong commented Aug 22, 2023

@ReenigneArcher I fixed a bug..when the SSH session exited / timeout, pulseaudio would be killed, resulting in no more sound. The solution was to disable PAM handlng of the SSH session.

docs/source/conf.py Outdated Show resolved Hide resolved
@e-dong
Copy link
Contributor Author

e-dong commented Aug 26, 2023

@ReenigneArcher - Feel free to continue to make reviews / comments. I greatly appreciate any feedback!

What I'm working on:

  • Static IP Address for Host can use more detail
  • Restructure the Uinput Permissions Workaround section, the script section makes it confusing. Instead I will put an order list of instructions relevant to updating the uinput permissions (E.g edit sudo config, create script that updates uinput permission, etc)
  • "Putting Everything Together" section can be more explicit, maybe something like Host entry point for streaming
  • Add a checkpoint section to make sure the user's setup is working so far in the guide. Probably before the ssh client script.
  • Add a note that the ssh client script is optional, just does some nice checking if X server / Sunshine is already running, and polling the server until ssh is ready after host is booting up.
  • Add a section on creating a custom resolution on the host (Good for streaming to a non standard device like MAC / iPAD) I will do this as a separate thing to do later. I can improve upon the changing resolution section in app examples.
  • Replace ssh info in about/usage: Start Sunshine over SSH (Linux/X11) with link to my guide.

@ReenigneArcher ReenigneArcher self-assigned this Sep 13, 2023
docs/source/about/guides/app_examples.rst Outdated Show resolved Hide resolved
docs/source/about/guides/app_examples.rst Outdated Show resolved Hide resolved
docs/source/about/guides/linux/headless_ssh.rst Outdated Show resolved Hide resolved
docs/source/about/usage.rst Outdated Show resolved Hide resolved
docs/source/about/guides/linux/headless_ssh.rst Outdated Show resolved Hide resolved
docs/source/about/guides/linux/headless_ssh.rst Outdated Show resolved Hide resolved
docs/source/about/guides/linux/headless_ssh.rst Outdated Show resolved Hide resolved
docs/source/about/guides/linux/headless_ssh.rst Outdated Show resolved Hide resolved
docs/source/about/guides/linux/headless_ssh.rst Outdated Show resolved Hide resolved
@ReenigneArcher ReenigneArcher merged commit b9bc4d6 into LizardByte:nightly Sep 14, 2023
@e-dong e-dong deleted the add-linux-ssh-guide branch September 15, 2023 00:26
KuleRucket pushed a commit to KuleRucket/Sunshine that referenced this pull request Jun 6, 2024
e-dong added a commit to e-dong/Sunshine that referenced this pull request Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants