Skip to content

Add comprehensive documentation for Sunshine game streaming#205

Merged
inffy merged 3 commits intomainfrom
copilot/fix-508cba94-b0a8-4e69-b0ca-afe5b7af08db
Sep 14, 2025
Merged

Add comprehensive documentation for Sunshine game streaming#205
inffy merged 3 commits intomainfrom
copilot/fix-508cba94-b0a8-4e69-b0ca-afe5b7af08db

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 14, 2025

Addresses issue #65 by adding comprehensive documentation for the Sunshine package that is included by default in Aurora.

What is Sunshine?

Sunshine is a self-hosted game streaming server that allows users to stream games from their Aurora desktop to any device running a Moonlight client. It's an open-source alternative to NVIDIA GameStream that works with any GPU and provides low-latency gaming with hardware-accelerated encoding.

Documentation Added

This PR adds a complete guide covering:

Core Features

  • Cross-platform streaming to phones, tablets, laptops, and other devices
  • Hardware acceleration support for AMD (VCE), Intel (QuickSync), and NVIDIA (NVENC) GPUs
  • Web-based configuration interface for easy setup
  • Remote desktop access for productivity use cases

Comprehensive Coverage

  • System requirements with specific GPU compatibility matrices
  • Step-by-step setup including client installation and device pairing
  • Aurora-specific setup using the ujust setup-sunshine command for service management
  • Configuration guide for display, audio, input, and network settings
  • Application management with examples for Steam and desktop streaming
  • Performance optimization with bitrate guidelines and hardware acceleration tips
  • Troubleshooting section covering common issues and solutions
  • Advanced usage including custom applications and multi-GPU setups
  • Security best practices and service management

Technical Details

  • Manual firewall configuration for required ports (47989-47990, 48010)
  • systemctl service management commands with Aurora convenience commands
  • Configuration file locations and structure
  • Log viewing and debugging instructions

Aurora Integration

The documentation is properly integrated into the Aurora documentation site and includes Aurora-specific features:

  • Added to the "User Guides" section in the sidebar navigation
  • Positioned between "Gaming on Aurora" and "Running Services Using Quadlet"
  • Includes proper breadcrumb navigation and cross-references
  • Features a comprehensive table of contents for easy navigation
  • Documents the ujust setup-sunshine command for Aurora service management
  • Provides clear guidance on manual firewall configuration requirements

This documentation provides Aurora users with everything they need to set up and use Sunshine for game streaming, making this powerful feature more accessible to the community with accurate Aurora-specific guidance.

Sunshine Documentation


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@inffy inffy changed the title [WIP] @ublue-os/aurora-docs/issues/65 we need a comprehensive documentation on the sunshine package and how to use it [WIP] comprehensive documentation on the sunshine package and how to use it Sep 14, 2025
@inffy inffy changed the title [WIP] comprehensive documentation on the sunshine package and how to use it feat: [WIP] comprehensive documentation on the sunshine package and how to use it Sep 14, 2025
Co-authored-by: inffy <10782843+inffy@users.noreply.github.com>
Copilot AI changed the title feat: [WIP] comprehensive documentation on the sunshine package and how to use it Add comprehensive documentation for Sunshine game streaming Sep 14, 2025
Copilot AI requested a review from inffy September 14, 2025 09:23
@inffy
Copy link
Copy Markdown
Member

inffy commented Sep 14, 2025

@copilot this is missing mentions of the ujust setup-sunshine command

@inffy
Copy link
Copy Markdown
Member

inffy commented Sep 14, 2025

Co-authored-by: inffy <10782843+inffy@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Sep 14, 2025

@copilot this is missing mentions of the ujust setup-sunshine command

Added documentation for the ujust setup-sunshine command. The documentation now includes the ujust command in the initial setup section, mentions it handles firewall configuration automatically, and provides it as the recommended way to set up Sunshine on Aurora. Commit: 22b7f9f

@inffy inffy marked this pull request as ready for review September 14, 2025 09:31
@inffy inffy changed the title Add comprehensive documentation for Sunshine game streaming feat: add comprehensive documentation for Sunshine game streaming Sep 14, 2025
@inffy inffy merged commit d77c4e9 into main Sep 14, 2025
3 of 4 checks passed
@inffy inffy deleted the copilot/fix-508cba94-b0a8-4e69-b0ca-afe5b7af08db branch September 14, 2025 09:32
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Sep 14, 2025

@copilot you can use https://github.com/ublue-os/aurora/blob/main/just/aurora-apps.just as instructions

Updated the documentation to accurately reflect the actual ujust setup-sunshine functionality based on the Aurora implementation. The command only manages the systemd service (enable/disable/start/stop) and provides portal access - it doesn't configure firewall rules or optimal settings as previously documented. Fixed in commit f9273f9.

Copilot AI changed the title feat: add comprehensive documentation for Sunshine game streaming Add comprehensive documentation for Sunshine game streaming Sep 14, 2025
@inffy inffy mentioned this pull request Oct 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants