-
Notifications
You must be signed in to change notification settings - Fork 2k
Update raspi-config #3945
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
Update raspi-config #3945
Changes from 7 commits
6d05f6e
9266bb4
5176cc8
e932d53
298c6f5
1607c3e
e8fcd5c
710ace6
49fc2b7
8652388
6e6ea7d
04944e7
0294da0
ecc1ccc
40838f7
75aa2ad
c08de12
8febb69
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,32 @@ | ||
| [[raspi-config]] | ||
| == `raspi-config` | ||
|
|
||
| TIP: Raspberry Pi Desktop users can access a graphical version of this application at **Preferences** > **Raspberry Pi Configuration**. However, some advanced configuration is only available in `raspi-config`. | ||
| `raspi-config` helps you configure your Raspberry Pi. Changes to `raspi-config` will affect xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] and various Linux configuration files. | ||
|
|
||
| `raspi-config` helps you configure your Raspberry Pi. Available options may differ between Raspberry Pi models. To open the configuration tool, run the following command: | ||
| === Getting started | ||
|
|
||
| To open the configuration tool from the desktop GUI, go to **Preferences** > **Raspberry Pi Configuration**. | ||
|
|
||
| Alternatively, to access the configuration tool via the terminal: | ||
|
||
|
|
||
| [source,console] | ||
| ---- | ||
| $ sudo raspi-config | ||
| ---- | ||
nathan-contino marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| You should see a blue screen with options in a grey box: | ||
|
|
||
| image::images/raspi-config.png[raspi-config main screen] | ||
|
|
||
| Use the **Up** and **Down** arrow keys to move the highlighted selection between the options available. | ||
|
|
||
| Press the **Right** arrow key or press **Tab** to access the `<Select>` and `<Finish>` buttons. Press **Left** or press **Tab** to return to the options. | ||
| To navigate the configuration tool from the terminal: | ||
|
|
||
| `raspi-config` automates edits to xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] and various Linux configuration files. Some options require a reboot to take effect. If you changed any of these, `raspi-config` asks you to reboot when you exit. | ||
| * Use the arrow keys to scroll through the settings list. | ||
nathan-contino marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * Access the `<Select>` or `<Finish>` options using the **Right** arrow or **Tab**. | ||
| * Return to the settings list using the **Left** arrow or **Tab**. | ||
| * Type a letter to jump ahead alphabetically. For example, type `E` to jump ahead to 'Europe' in the time zone list. | ||
|
|
||
| TIP: In long lists of option values (like the list of timezone cities), type a letter to skip to that section of the list. For example, enter `L` to skip to Lisbon. | ||
| image::images/raspi-config.png[raspi-config main screen] | ||
|
|
||
| [[menu-options]] | ||
| === System options | ||
|
|
||
| The system options submenu allows you to make configuration changes to various parts of the boot, login and networking process, along with some other system level changes. | ||
|
|
||
| image::images/raspi-system.png[raspi-config system options] | ||
| Configure parts of the boot, login, and networking process, along with other system level changes. | ||
|
|
||
| ==== Wireless LAN | ||
|
|
||
|
|
@@ -49,9 +48,9 @@ For more information, see xref:configuration.adoc#change-user-password[Change a | |
| Set the visible xref:remote-access.adoc#resolve-raspberrypi-local-with-mdns[mDNS] name for this Raspberry Pi on a network. | ||
|
|
||
| [[boot-options]] | ||
| ==== Boot/auto login | ||
| ==== Boot/Auto login | ||
|
|
||
| Select whether to boot to console or desktop, and whether or not your Raspberry Pi automatically logs into your current user account when powered on. | ||
| Boot to console or desktop with the option of an automatic login to your current user account. | ||
|
|
||
| ==== Network at boot | ||
|
|
||
|
|
@@ -71,12 +70,10 @@ Change the default web browser. | |
|
|
||
| === Display options | ||
|
|
||
| image::images/raspi-display.png[raspi-config display options] | ||
|
|
||
| [[underscan]] | ||
| ==== Underscan | ||
|
|
||
| NOTE: Not available when running Wayland. | ||
| NOTE: Unavailable when running Wayland. | ||
|
|
||
| If the initial text shown on the screen disappears off the edge, enable overscan to adjust the border. On some displays, particularly monitors, disabling overscan will make the picture fill the whole screen and remove the black border. | ||
|
|
||
|
|
@@ -102,14 +99,12 @@ Enable or disable 4Kp60 resolution for HDMI outputs. | |
|
|
||
| Enable and disable various physical and virtual interfaces. | ||
|
|
||
| image::images/raspi-interface.png[raspi-config interface options] | ||
|
|
||
| [[ssh]] | ||
| ==== SSH | ||
|
|
||
| Enable or disable remote terminal access to your Raspberry Pi using SSH. | ||
|
|
||
| SSH allows you to remotely access the command line of the Raspberry Pi from another computer. SSH is disabled by default. Read more about using SSH on the xref:remote-access.adoc#ssh[SSH documentation page]. If connecting your Raspberry Pi directly to a public network, you should not enable SSH unless you have set up secure passwords for all users. | ||
| SSH allows you to remotely access the command line of the Raspberry Pi from another computer. SSH is disabled by default. If connecting your Raspberry Pi directly to a public network, set up secure passwords for all users before enabling SSH. Learn more about using SSH on the xref:remote-access.adoc#ssh[SSH documentation page]. | ||
nathan-contino marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [[rpi-connect]] | ||
| ==== RPi Connect | ||
|
|
@@ -147,8 +142,6 @@ Enable or disable remote access to the GPIO pins. | |
|
|
||
| === Performance options | ||
|
|
||
| image::images/raspi-perf.png[raspi-config performance options] | ||
|
|
||
| [[overclock]] | ||
| ==== Overclock | ||
|
|
||
|
|
@@ -167,15 +160,13 @@ Enable or disable a read-only filesystem. | |
|
|
||
| ==== Fan | ||
|
|
||
| Customise the behaviour of the GPIO-connected https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/[Raspberry Pi 4 Case Fan]. Does not affect the fans in the https://www.raspberrypi.com/products/raspberry-pi-5-case/[Raspberry Pi 5 Case for Raspberry Pi 5] or https://www.raspberrypi.com/products/active-cooler/[Raspberry Pi 5 Active Cooler], which connect using a special four-pin fan header. | ||
| Customise the behaviour of the GPIO-connected https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/[Raspberry Pi 4 Case Fan]. This setting is inapplicable to other fan models. | ||
nathan-contino marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [[localisation-options]] | ||
| === Localisation options | ||
|
|
||
| Configure location and country-related options. | ||
|
|
||
| image::images/raspi-l18n.png[raspi-config localisation options] | ||
|
|
||
| [[change-locale]] | ||
| ==== Locale | ||
|
|
||
|
|
@@ -184,26 +175,28 @@ Select a locale, for example `en_GB.UTF-8 UTF-8`. | |
| [[change-timezone]] | ||
| ==== Time zone | ||
|
|
||
| Sets your local time zone, starting with the region then selecting a city, e.g. "Europe/London". Type a letter to jump to that letter in the list. | ||
| Set your local time zone in the format `Region/City`, for example 'Europe/London'. Type a letter to jump to that letter in the list. | ||
|
|
||
| [[change-keyboard-layout]] | ||
| ==== Keyboard | ||
|
|
||
| Opens a menu where you can select your keyboard layout. Changes usually take effect immediately, but may require a reboot. Type a letter to jump to that letter in the list. | ||
| Open a menu where you can select your keyboard layout. Changes usually take effect immediately, but may require a reboot. Type a letter to jump to that letter in the list. | ||
|
|
||
| ==== WLAN country | ||
|
|
||
| Sets the country code for your wireless network. | ||
| Set the country code for your wireless network. | ||
|
|
||
| [[advanced-options]] | ||
| === Advanced options | ||
|
|
||
| image::images/raspi-adv.png[raspi-config advanced options] | ||
| Advanced options are intended for use during troubleshooting. Available options may differ between Raspberry Pi models. | ||
nathan-contino marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| WARNING: Changes to advanced options may prevent your Raspberry Pi from working as intended. Avoid configuring advanced options unless instructed by a Raspberry Pi engineer. | ||
|
|
||
| [[expand-filesystem]] | ||
| ==== Expand filesystem | ||
|
|
||
| Expands your OS partition to fill the whole storage device, giving you more space to use for files. Reboot your Raspberry Pi to complete this action. Normally, Raspberry Pi OS runs this action on first boot. This option can be useful if you clone your OS to a separate storage device with more capacity than the original. | ||
| Expand your OS partition to fill the whole storage device, giving you more space to use for files. Reboot your Raspberry Pi to complete this action. Normally, Raspberry Pi OS runs this action on first boot. This option can be useful if you clone your OS to a separate storage device with more capacity than the original. | ||
|
|
||
| WARNING: There is no confirmation step. Selecting the option begins the partition expansion immediately. | ||
|
|
||
|
|
@@ -217,7 +210,7 @@ Configure the network's proxy settings. | |
|
|
||
| ==== Boot order | ||
|
|
||
| On Raspberry Pi 4 and later, specify whether to boot from USB or network if the SD card isn't inserted. For more information, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration]. | ||
| On Raspberry Pi 4 and later, specify whether to boot from USB or network in absence of an SD card. For more information, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration]. | ||
nathan-contino marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ==== Bootloader version | ||
|
|
||
|
|
@@ -246,7 +239,7 @@ Display a description of `raspi-config`. | |
| [[finish]] | ||
| === Finish | ||
|
|
||
| Exits `raspi-config`. If you made changes that require a reboot, `raspi-config` prompts you to reboot. When implementing changes for the first time, it's best to reboot. If you chose to resize your SD card, rebooting may take longer than usual. | ||
| Exit `raspi-config`. If necessary, raspi-config will ask you to reboot when you exit. When implementing changes for the first time, reboot to ensure your changes take effect. | ||
nathan-contino marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [[raspi-config-cli]] | ||
| == non-interactive `raspi-config` | ||
|
|
@@ -277,7 +270,7 @@ Pass a wireless network name (SSID) and passphrase, if required. The following f | |
|
|
||
| The `<hidden>` option indicates the visibility of the SSID. If the network broadcasts an open SSID, pass `0` or omit the option. If your SSID is hidden, pass `1`. Defaults to `0`. | ||
|
|
||
| The `<plain>` option indicates whether or not you intend to pass the passphrase as plaintext. If your passphrase includes a space or a special character like `!`, you must pass `0` and use quotes around your passphrase. Otherwise, you can pass `1` or omit the option. Defaults to `1`. To pass this option, you must specify a value for `<hidden>`. | ||
| The `<plain>` option indicates whether you intend to pass the passphrase as plaintext. If your passphrase includes a space or a special character like `!`, you must pass `0` and use quotes around your passphrase. Otherwise, you can pass `1` or omit the option. Defaults to `1`. To pass this option, you must specify a value for `<hidden>`. | ||
|
|
||
| For example, run the following commands to connect to a: | ||
|
|
||
|
|
@@ -344,9 +337,9 @@ $ sudo raspi-config nonint do_hostname <hostname> | |
| ---- | ||
|
|
||
| [[boot-options-nonint]] | ||
| ==== Boot/auto login | ||
| ==== Boot/Auto login | ||
|
|
||
| Select whether to boot to console or desktop, and whether or not your Raspberry Pi automatically logs into your current user account when powered on. | ||
| Boot to console or desktop with the option of an automatic login to your current user account. | ||
nathan-contino marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [source,console] | ||
| ---- | ||
|
|
@@ -408,7 +401,7 @@ $ sudo raspi-config nonint do_browser <chromium-browser/firefox> | |
| [[underscan-nonint]] | ||
| ==== Underscan | ||
|
|
||
| NOTE: Not available when running Wayland. | ||
| NOTE: Unavailable when running Wayland. | ||
|
|
||
| If the initial text shown on the screen disappears off the edge, enable overscan to adjust the border. On some displays, particularly monitors, disabling overscan will make the picture fill the whole screen and remove the black border. | ||
|
|
||
|
|
@@ -641,7 +634,7 @@ $ sudo raspi-config nonint do_overlayfs <0/1> | |
|
|
||
| ==== Fan | ||
|
|
||
| Customise the behaviour of the GPIO-connected https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/[Raspberry Pi 4 Case Fan]. Does not affect the fans in the https://www.raspberrypi.com/products/raspberry-pi-5-case/[Raspberry Pi 5 Case for Raspberry Pi 5] or https://www.raspberrypi.com/products/active-cooler/[Raspberry Pi 5 Active Cooler], which connect using a special four-pin fan header. | ||
| Customise the behaviour of the GPIO-connected https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/[Raspberry Pi 4 Case Fan]. This setting is inapplicable to other fan models. | ||
|
|
||
| [source,console] | ||
| ---- | ||
|
|
@@ -673,7 +666,7 @@ For a full list of possible `<locale>` values, see the abbreviations used in the | |
| [[change-timezone-nonint]] | ||
| ==== Time zone | ||
|
|
||
| Set your local time zone, starting with the region then selecting a city, e.g. "Europe/London". | ||
| Set your local time zone in the format `Region/City`, for example 'Europe/London'. Type a letter to jump to that letter in the list. | ||
nathan-contino marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [source,console] | ||
| ---- | ||
|
|
@@ -708,6 +701,10 @@ For a full list of possible `<country>` values, see the abbreviations used in th | |
| [[advanced-options-nonint]] | ||
| === Advanced options | ||
|
|
||
| Advanced options are intended for use during troubleshooting. Available options may differ between Raspberry Pi models. | ||
nathan-contino marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| WARNING: Changes to advanced options may prevent your Raspberry Pi from working as intended. Avoid configuring advanced options unless instructed by a Raspberry Pi engineer. | ||
|
|
||
| [[expand-filesystem-nonint]] | ||
| ==== Expand filesystem | ||
|
|
||
|
|
@@ -743,7 +740,7 @@ $ sudo raspi-config nonint do_proxy <SCHEMES> <ADDRESS> | |
|
|
||
| ==== Boot order | ||
|
|
||
| On the Raspberry Pi 4 and later, specify whether to boot from USB or network if the SD card isn't inserted. See the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] section for more information. | ||
| On the Raspberry Pi 4 and later, specify whether to boot from USB or network in absence of an SD card. See the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] section for more information. | ||
|
|
||
| [source,console] | ||
| ---- | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.