wsl-distribution.conf¶
The configuration file used during installation and partially during the import of a distribution. This reference includes all known parameters, their possible values, dependencies, and default settings.
Overview¶
- Distribution configuration file.
- Located at
/etc/wsl-distribution.conf. - All settings are applied during the installation of the distribution.
- The Out-of-Box Experience script is not started when importing the distribution.
- Uses the INI format, with settings grouped into sections.
Settings¶
OOBE¶
The settings described below are located in the [oobe] section.
command¶
# Specifies the path to the Out-of-Box Experience (OOBE) script, executed
# after installation of the distribution on its first launch
# Example: /usr/lib/wsl/oobe-script
command = /path/to/oobe-script
defaultUid¶
# Specifies the default UID used when installing the distribution
# and during its first launch
# Default: 1000
defaultUid = 1000
defaultName¶
# Specifies the default distribution name used in the Windows Start menu
# and Windows Terminal shortcuts
defaultName = <DistroName>
Shortcut¶
The settings described below are located in the [shortcut] section.
enabled¶
# Enables creation of distribution shortcuts in the Windows Start menu
# Default: true
# Values:
# - true
# - false
enabled = true
icon¶
# Specifies the path to the icon used for Windows Start menu
# and Windows Terminal shortcuts
# Example: /usr/share/wsl/<DistroIcon>.ico
icon = /path/to/<DistroIcon>.ico
Windows Terminal¶
The settings described below are located in the [windowsterminal] section.
enabled¶
# Enables creation of the distribution profile in Windows Terminal
# Default: true
# Values:
# - true
# - false
enabled = true
ProfileTemplate¶
# Specifies the path to a JSON profile template used for creating
# the distribution profile in Windows Terminal
# Example: /usr/share/wsl/terminal-profile.json
ProfileTemplate = /path/to/terminal-profile.json
Full configuration¶
This is the fully documented per-distribution configuration file reference and template.
# Distribution configuration file wsl-distribution.conf
# Location: /etc/wsl-distribution.conf
[oobe]
# Specifies the path to the Out-of-Box Experience (OOBE) script, executed
# after installation of the distribution on its first launch
# Example: /usr/lib/wsl/oobe-script
command = /path/to/oobe-script
# Specifies the default UID used when installing the distribution
# and during its first launch
# Default: 1000
defaultUid = 1000
# Specifies the default distribution name used in the Windows Start menu
# and Windows Terminal shortcuts
defaultName = <DistroName>
[shortcut]
# Enables creation of distribution shortcuts in the Windows Start menu
# Default: true
# Values:
# - true
# - false
enabled = true
# Specifies the path to the icon used for Windows Start menu
# and Windows Terminal shortcuts
# Example: /usr/share/wsl/<DistroIcon>.ico
icon = /path/to/<DistroIcon>.ico
[windowsterminal]
# Enables creation of the distribution profile in Windows Terminal
# Default: true
# Values:
# - true
# - false
enabled = true
# Specifies the path to a JSON profile template used for creating
# the distribution profile in Windows Terminal
# Example: /usr/share/wsl/terminal-profile.json
ProfileTemplate = /path/to/terminal-profile.json