Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
6d05f6e
clean up introduction
Nov 28, 2024
9266bb4
add warning to advanced options
Nov 28, 2024
5176cc8
nits
Nov 28, 2024
e932d53
add warning to advanced options non-int
Nov 28, 2024
298c6f5
readability nits
Nov 28, 2024
1607c3e
add note about differing advanced options for different pi models
Nov 28, 2024
e8fcd5c
remove images
Nov 29, 2024
8f4e25d
Make CSI and DSI connector spec even more descriptive
nathan-contino Dec 2, 2024
0236e11
Bump nokogiri from 1.16.7 to 1.16.8
dependabot[bot] Dec 2, 2024
c3e5b86
Merge pull request #3948 from raspberrypi/dependabot/bundler/develop/…
nathan-contino Dec 3, 2024
710ace6
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
49fc2b7
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
8652388
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
6e6ea7d
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
04944e7
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
0294da0
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
ecc1ccc
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
40838f7
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
75aa2ad
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
c08de12
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
8febb69
Update documentation/asciidoc/computers/configuration/raspi-config.adoc
nathan-contino Dec 3, 2024
dd90d31
Merge pull request #3945 from raspberrypi/update-raspi-config
nathan-contino Dec 3, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -57,18 +57,18 @@ GEM
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
mini_portile2 (2.8.7)
mini_portile2 (2.8.8)
minima (2.5.2)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
nokogiri (1.16.7)
nokogiri (1.16.8)
mini_portile2 (~> 2.8.2)
racc (~> 1.4)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (6.0.1)
racc (1.8.0)
racc (1.8.1)
rake (13.2.1)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
80 changes: 40 additions & 40 deletions documentation/asciidoc/computers/configuration/raspi-config.adoc
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
[[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 modify xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] and other 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, run the following command to access the configuration tool via the terminal:

[source,console]
----
$ sudo raspi-config
----

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.
TIP: Some advanced configuration is available in the `raspi-config` CLI, but not the Raspberry Pi Configuration GUI.

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 up and down arrow keys to scroll through the settings list.
* 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

Expand All @@ -49,9 +50,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

Expand All @@ -71,12 +72,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.

Expand All @@ -102,14 +101,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. For more information about SSH, see the xref:remote-access.adoc#ssh[SSH documentation].

[[rpi-connect]]
==== RPi Connect
Expand Down Expand Up @@ -147,8 +144,6 @@ Enable or disable remote access to the GPIO pins.

=== Performance options

image::images/raspi-perf.png[raspi-config performance options]

[[overclock]]
==== Overclock

Expand All @@ -167,15 +162,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]. Not applicable to other fan models.

[[localisation-options]]
=== Localisation options

Configure location and country-related options.

image::images/raspi-l18n.png[raspi-config localisation options]

[[change-locale]]
==== Locale

Expand All @@ -184,26 +177,27 @@ 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]

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.

Expand All @@ -217,7 +211,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 when no SD card or SSD has been detected. For more information, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration].

==== Bootloader version

Expand Down Expand Up @@ -246,7 +240,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.

[[raspi-config-cli]]
== non-interactive `raspi-config`
Expand Down Expand Up @@ -277,7 +271,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:

Expand Down Expand Up @@ -344,9 +338,12 @@ $ sudo raspi-config nonint do_hostname <hostname>
----

[[boot-options-nonint]]
==== Boot/auto login
==== Boot/Auto login

Select the following behaviour at boot time:

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.
* whether to boot to console or desktop
* whether your Raspberry Pi automatically logs into your current user account when powered on

[source,console]
----
Expand Down Expand Up @@ -408,7 +405,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.

Expand Down Expand Up @@ -641,7 +638,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]
----
Expand Down Expand Up @@ -673,7 +670,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.

[source,console]
----
Expand Down Expand Up @@ -708,6 +705,9 @@ For a full list of possible `<country>` values, see the abbreviations used in th
[[advanced-options-nonint]]
=== Advanced options


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

Expand Down Expand Up @@ -743,7 +743,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]
----
Expand Down
42 changes: 22 additions & 20 deletions documentation/asciidoc/computers/raspberry-pi/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ a|
a|
* HDMI
* 2× USB 2.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm audio jack
* RCA composite video
* 100Mb/s Ethernet RJ45
Expand All @@ -42,8 +42,8 @@ image::images/model-a.jpg[alt="Raspberry Pi Model A",width="80%"]
a|
* HDMI
* USB 2.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm audio jack
* RCA composite video
* SD card slot
Expand All @@ -55,8 +55,8 @@ image::images/model-b-plus.jpg[alt="Raspberry Pi Model B+"]
a|
* HDMI
* 4× USB 2.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm AV jack
* 100Mb/s Ethernet RJ45
* microSD card slot
Expand All @@ -72,8 +72,8 @@ a|
a|
* HDMI
* USB 2.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm AV jack
* microSD card slot
* micro USB power
Expand All @@ -84,8 +84,8 @@ image::images/2-model-b.jpg[alt="Raspberry Pi 2 Model B"]
a|
* HDMI
* 4× USB 2.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm AV jack
* 100Mb/s Ethernet RJ45
* microSD card slot
Expand All @@ -97,8 +97,8 @@ image::images/3-model-b.jpg[alt="Raspberry Pi 3 Model B"]
a|
* HDMI
* 4× USB 2.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm AV jack
* 100Mb/s Ethernet RJ45
* 2.4GHz single-band 802.11n Wi-Fi (35Mb/s)
Expand All @@ -112,8 +112,8 @@ image::images/3-model-b-plus.jpg[alt="Raspberry Pi 3 Model B+"]
a|
* HDMI
* 4× USB 2.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm AV jack
* 300Mb/s Ethernet RJ45 with PoE support
* 2.4/5GHz dual-band 802.11ac Wi-Fi (100Mb/s)
Expand All @@ -127,8 +127,8 @@ image::images/3-model-a-plus.jpg[alt="Raspberry Pi 3 Model A+"]
a|
* HDMI
* USB 2.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm AV jack
* 2.4/5GHz dual-band 802.11ac Wi-Fi (100Mb/s)
* Bluetooth 4.2, Bluetooth Low Energy (BLE)
Expand All @@ -150,8 +150,8 @@ a|
* 2× micro HDMI
* 2× USB 2.0
* 2× USB 3.0
* 15-pin 16mm CSI camera port
* 15-pin 16mm DSI display port
* standard 15-pin, 1.0mm pitch, 16mm width, CSI (camera) port
* standard 15-pin, 1.0mm pitch, 16mm width, DSI (display) port
* 3.5mm AV jack
* Gigabit (1Gb/s) Ethernet RJ45 with PoE+ support
* 2.4/5GHz dual-band 802.11ac Wi-Fi (120Mb/s)
Expand Down Expand Up @@ -185,7 +185,7 @@ a|
* 2× micro HDMI
* 2× USB 2.0
* 2× USB 3.0
* 2× 22-pin 11.5mm CSI/DSI combined camera/display ports
* 2× mini 22-pin, 0.5mm (fine) pitch, 11.5mm width, combined CSI (camera)/DSI (display) ports
* single-lane https://datasheets.raspberrypi.com/pcie/pcie-connector-standard.pdf[PCIe FFC connector]
* https://datasheets.raspberrypi.com/debug/debug-connector-specification.pdf[UART connector]
* RTC battery connector
Expand All @@ -209,7 +209,9 @@ All Zero models have the following connectivity:
* a mini HDMI port
* 2× micro USB ports (one for input power, one for external devices)

Since version 1.3 of the original Zero, all zero models have also included a 22-pin 11.5mm CSI camera port.
Since version 1.3 of the original Zero, all Zero models also include:

* a mini 22-pin, 0.5mm (fine) pitch, 11.5mm width, CSI (camera) port

[cols="3a,1,1,1,2"]
|===
Expand Down
Loading