Configuration

@admonition{ Host authority | @htmlonly By providing the host authority (URI + port), you can easily open each configuration option in the config UI.

Host authority: @endhtmlonly }

Sunshine will work with the default settings for most users. In some cases you may want to configure Sunshine further.

The default location for the configuration file is listed below. You can use another location if you choose, by passing in the full configuration file path as the first argument when you start Sunshine.

Example

sunshine ~/sunshine_config.conf

The default location of the apps.json is the same as the configuration file. You can use a custom location by modifying the configuration file.

Default Config Directory

OS	Location
Docker	@code{}/config@endcode
FreeBSD	@code{}~/.config/sunshine@endcode
Linux	@code{}~/.config/sunshine@endcode
macOS	@code{}~/.config/sunshine@endcode
Windows	@code{}%ProgramFiles%\Sunshine\config@endcode

Although it is recommended to use the configuration UI, it is possible manually configure Sunshine by editing the conf file in a text editor. Use the examples as reference.

The web UI groups these settings into the sidebar categories documented below. Encoder categories are shown only when supported on the current platform.

General

locale

sunshine_name

min_log_level

global_prep_cmd

notify_pre_releases

system_tray

Input

controller

gamepad_driver

gamepad

ds4_back_as_touchpad_click

motion_as_ds4

touchpad_as_ds4

virtualhid_randomize_mac

back_button_timeout

keyboard

key_repeat_delay

key_repeat_frequency

always_send_scancodes

key_rightalt_to_key_win

mouse

high_resolution_scrolling

native_pen_touch

keybindings

Audio/Video

audio_sink

virtual_sink

stream_audio

install_steam_audio_drivers

adapter_name

output_name

dd_configuration_option

dd_resolution_option

dd_manual_resolution

dd_refresh_rate_option

dd_manual_refresh_rate

dd_hdr_option

dd_wa_hdr_toggle_delay

dd_config_revert_delay

dd_config_revert_on_disconnect

dd_mode_remapping

max_bitrate

minimum_fps_target

Network

upnp

address_family

bind_address

port

origin_web_ui_allowed

csrf_allowed_origins

external_ip

lan_encryption_mode

wan_encryption_mode

ping_timeout

packetsize

Config Files

file_apps

credentials_file

log_path

pkey

cert

file_state

Advanced

fec_percentage

qp

min_threads

hevc_mode

av1_mode

capture

qemu_dbus_address

encoder

NVIDIA NVENC Encoder

nvenc_preset

nvenc_twopass

nvenc_spatial_aq

nvenc_vbv_increase

nvenc_realtime_hags

nvenc_split_encode

nvenc_latency_over_power

nvenc_opengl_vulkan_on_dxgi

nvenc_h264_cavlc

Intel QuickSync Encoder

qsv_preset

qsv_coder

qsv_slow_hevc

AMD AMF Encoder

amd_usage

amd_rc

amd_enforce_hrd

amd_max_au_size

amd_quality

amd_preanalysis

amd_vbaq

amd_coder

VideoToolbox Encoder

vt_coder

vt_software

vt_realtime

VA-API Encoder

vaapi_blbrc

vaapi_quality

vaapi_rc

vaapi_strict_rc_buffer

Vulkan Encoder

vk_tune

vk_rc_mode

Software Encoder

sw_preset

sw_tune

Previous	Next
Legal	App Examples