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

docs: use github admonition styles (#4263)

Browse Source
This commit is contained in:
ReenigneArcher
2025-09-16 19:01:39 -04:00
committed by GitHub
parent cadc89aa14
commit 9f6c832583
9 changed files with 223 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
docs/getting_started.md
View File

@@ -11,14 +11,17 @@ and release artifacts may be missing when merging changes on a faster cadence.
Binaries of Sunshine are created for each release. They are available for Linux, macOS, and Windows.
Binaries can be found in the [latest release][latest-release].
@tip{Some third party packages also exist.
See [Third Party Packages](third_party_packages.md) for more information.
No support will be provided for third party packages!}
> [!NOTE]
> Some third party packages also exist.
> See [Third Party Packages](third_party_packages.md) for more information.
> No support will be provided for third party packages!
## Install
### Docker
@warning{The Docker images are not recommended for most users.}
> [!WARNING]
> The Docker images are not recommended for most users.
Docker images are available on [Dockerhub.io](https://hub.docker.com/repository/docker/lizardbyte/sunshine)
and [ghcr.io](https://github.com/orgs/LizardByte/packages?repo_name=sunshine).
@@ -30,9 +33,10 @@ See [Docker](../DOCKER_README.md) for more information.
CUDA is used for NVFBC capture.
@tip{See [CUDA GPUS](https://developer.nvidia.com/cuda-gpus) to cross-reference Compute Capability to your GPU.
The table below applies to packages provided by LizardByte. If you use an official LizardByte package, then you do not
need to install CUDA.}
> [!NOTE]
> See [CUDA GPUS](https://developer.nvidia.com/cuda-gpus) to cross-reference Compute Capability to your GPU.
> The table below applies to packages provided by LizardByte. If you use an official LizardByte package, then you do not
> need to install CUDA.
<table>
<caption>CUDA Compatibility</caption>
@@ -72,7 +76,9 @@ need to install CUDA.}
</table>
#### AppImage
@caution{Use distro-specific packages instead of the AppImage if they are available.}
> [!CAUTION]
> Use distro-specific packages instead of the AppImage if they are available.
According to AppImageLint the supported distro matrix of the AppImage is below.
@@ -113,7 +119,9 @@ According to AppImageLint the supported distro matrix of the AppImage is below.
```
#### ArchLinux
@warning{We do not provide support for any AUR packages.}
> [!CAUTION]
> Use AUR packages at your own risk.
##### Install Prebuilt Packages
Follow the instructions at LizardByte's [pacman-repo](https://github.com/LizardByte/pacman-repo) to add
@@ -148,10 +156,12 @@ Download `sunshine-{distro}-{distro-version}-{arch}.deb` and run the following c
sudo dpkg -i ./sunshine-{distro}-{distro-version}-{arch}.deb
```
@note{The `{distro-version}` is the version of the distro we built the package on. The `{arch}` is the
architecture of your operating system.}
> [!NOTE]
> The `{distro-version}` is the version of the distro we built the package on. The `{arch}` is the
> architecture of your operating system.
@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.
##### Uninstall
```bash
@@ -159,7 +169,9 @@ sudo apt remove sunshine
```
#### Fedora
@tip{The package name is case-sensitive.}
> [!TIP]
> The package name is case-sensitive.
##### Install
1. Enable copr repository.
@@ -183,13 +195,17 @@ sudo dnf remove Sunshine
```
#### Flatpak
@caution{Use distro-specific packages instead of the Flatpak if they are available.}
> [!CAUTION]
> Use distro-specific packages instead of the Flatpak if they are available.
Using this package requires that you have [Flatpak](https://flatpak.org/setup) installed.
##### Download (local option)
1. Download `sunshine_{arch}.flatpak` and run the following command.
@note{Replace `{arch}` with your system architecture.}
> [!NOTE]
> Replace `{arch}` with your system architecture.
##### Install (system level)
**Flathub**
@@ -235,7 +251,9 @@ flatpak uninstall --delete-data dev.lizardbyte.app.Sunshine
```
#### Homebrew
@important{The Homebrew package is experimental on Linux.}
> [!IMPORTANT]
> The Homebrew package is experimental on Linux.
This package requires that you have [Homebrew](https://docs.brew.sh/Installation) installed.
@@ -254,7 +272,8 @@ brew uninstall sunshine
### macOS
@important{Sunshine on macOS is experimental. Gamepads do not work.}
> [!IMPORTANT]
> Sunshine on macOS is experimental. Gamepads do not work.
#### Homebrew
This package requires that you have [Homebrew](https://docs.brew.sh/Installation) installed.
@@ -270,7 +289,8 @@ brew install sunshine
brew uninstall sunshine
```
@tip{For beta you can replace `sunshine` with `sunshine-beta` in the above commands.}
> [!TIP]
> For beta you can replace `sunshine` with `sunshine-beta` in the above commands.
### Windows
@@ -279,16 +299,18 @@ brew uninstall sunshine
1. Download and install
[Sunshine-Windows-AMD64-installer.exe](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-installer.exe)
@attention{You should carefully select or unselect the options you want to install. Do not blindly install or
enable features.}
> [!CAUTION]
> You should carefully select or unselect the options you want to install. Do not blindly install or
> enable features.
To uninstall, find Sunshine in the list <a href="ms-settings:installed-apps">here</a> and select "Uninstall" from the
overflow menu. Different versions of Windows may provide slightly different steps for uninstall.
#### Standalone (lite version)
@warning{By using this package instead of the installer, performance will be reduced. This package is not
recommended for most users. No support will be provided!}
> [!WARNING]
> By using this package instead of the installer, performance will be reduced. This package is not
> recommended for most users. No support will be provided!
1. Download and extract
[Sunshine-Windows-AMD64-portable.zip](https://github.com/LizardByte/Sunshine/releases/latest/download/Sunshine-Windows-AMD64-portable.zip)
@@ -342,9 +364,13 @@ After installation, some initial setup is required.
### Linux
#### KMS Capture
@warning{Capture of most Wayland-based desktop environments will fail unless this step is performed.}
@note{`cap_sys_admin` may as well be root, except you don't need to be root to run the program. This is necessary to
allow Sunshine to use KMS capture.}
> [!WARNING]
> Capture of most Wayland-based desktop environments will fail unless this step is performed.
> [!NOTE]
> `cap_sys_admin` may as well be root, except you don't need to be root to run the program. This is necessary to
> allow Sunshine to use KMS capture.
##### Enable
```bash
@@ -377,8 +403,11 @@ Sunshine can only access microphones on macOS due to system limitations. To stre
[Soundflower](https://github.com/mattingalls/Soundflower) or
[BlackHole](https://github.com/ExistentialAudio/BlackHole).
@note{Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key.}
@caution{Gamepads are not currently supported.}
> [!NOTE]
> Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key.
> [!CAUTION]
> Gamepads are not currently supported.
## Usage
@@ -386,8 +415,9 @@ Sunshine can only access microphones on macOS due to system limitations. To stre
If Sunshine is not installed/running as a service, then start Sunshine with the following command, unless a start
command is listed in the specified package [install](#install) instructions above.
@note{A service is a process that runs in the background. This is the default when installing Sunshine from the
Windows installer. Running multiple instances of Sunshine is not advised.}
> [!NOTE]
> A service is a process that runs in the background. This is the default when installing Sunshine from the
> Windows installer. Running multiple instances of Sunshine is not advised.
```bash
sunshine
@@ -398,9 +428,11 @@ sunshine
sunshine <directory of conf file>/sunshine.conf
```
@note{You do not need to specify a config file. If no config file is entered the default location will be used.}
> [!NOTE]
> You do not need to specify a config file. If no config file is entered, the default location will be used.
@attention{The configuration file specified will be created if it doesn't exist.}
> [!TIP]
> The configuration file specified will be created if it doesn't exist.
### Start Sunshine over SSH (Linux/X11)
Assuming you are already logged into the host, you can use this command
@@ -417,9 +449,10 @@ be ready.
ssh <user>@<ip_address> 'startx &; export DISPLAY=:0; sunshine'
```
@tip{You could also utilize the `~/.bash_profile` or `~/.bashrc` files to set up the `DISPLAY` variable.}
> [!TIP]
> You could also use the `~/.bash_profile` or `~/.bashrc` files to set up the `DISPLAY` variable.
@seealso{ See [Remote SSH Headless Setup](https://app.lizardbyte.dev/2023-09-14-remote-ssh-headless-sunshine-setup)
@seealso{See [Remote SSH Headless Setup](https://app.lizardbyte.dev/2023-09-14-remote-ssh-headless-sunshine-setup)
on how to set up a headless streaming server without autologin and dummy plugs (X11 + NVidia GPUs)}
### Configuration
@@ -427,10 +460,12 @@ on how to set up a headless streaming server without autologin and dummy plugs (
Sunshine is configured via the web ui, which is available on [https://localhost:47990](https://localhost:47990)
by default. You may replace *localhost* with your internal ip address.
@attention{Ignore any warning given by your browser about "insecure website". This is due to the SSL certificate
being self-signed.}
> [!NOTE]
> Ignore any warning given by your browser about "insecure website". This is due to the SSL certificate
> being self-signed.
@caution{If running for the first time, make sure to note the username and password that you created.}
> [!CAUTION]
> If running for the first time, make sure to note the username and password that you created.
1. Add games and applications.
2. Adjust any configuration settings as needed.