Skip to content

Commit

Permalink
Merge pull request #3983 from raspberrypi/develop
Browse files Browse the repository at this point in the history
Release to production
  • Loading branch information
nathan-contino authored Dec 13, 2024
2 parents 63eaed0 + adf8fb6 commit a58bf2b
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 43 deletions.
24 changes: 12 additions & 12 deletions documentation/asciidoc/computers/getting-started/configuring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ First, unplug your Raspberry Pi's power supply to ensure that the Raspberry Pi i
If you installed the operating system on a microSD card, you can plug it into your Raspberry Pi's card slot now.
If you installed the operating system on any other storage device, you can connect it to your Raspberry Pi now.

image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspberry Pi."]
image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspberry Pi.",width="80%"]

Then, plug in any other peripherals, such as your mouse, keyboard, and monitor.

image::images/peripherals/cable-all.png[alt="Attaching the power supply to a Raspberry Pi."]
image::images/peripherals/cable-all.png[alt="Attaching the power supply to a Raspberry Pi.",width="80%"]

Finally, connect the power supply to your Raspberry Pi. You should see the status LED light up when your Pi powers on. If your Pi is connected to a display, you should see the boot screen within minutes.

Expand All @@ -26,7 +26,7 @@ If your Raspberry Pi does not boot within 5 minutes, check the status LED. If it

If you chose to skip OS customisation in Imager, your Raspberry Pi will run a configuration wizard on first boot. You need a monitor and keyboard to navigate through the wizard; a mouse is optional.

image::images/initial-setup/start.png[alt="Click Next to get started with configuration."]
image::images/initial-setup/start.png[alt="Click Next to get started with configuration.",width="80%"]

=== Bluetooth

Expand All @@ -38,50 +38,50 @@ This process works with built-in or external USB Bluetooth adapters. If you use

This page helps you configure your country, language, and time zone, and keyboard layout.

image::images/initial-setup/locale.png[alt="Adjust country, language, time zone, and keyboard layout."]
image::images/initial-setup/locale.png[alt="Adjust country, language, time zone, and keyboard layout.",width="80%"]

=== User

This page helps you configure the username and password for the default user account.

By default, older versions of Raspberry Pi OS set the username to "pi". If you use the username "pi", avoid the old default password of "raspberry" to keep your Raspberry Pi secure.

image::images/initial-setup/user.png[alt="Create your username and password."]
image::images/initial-setup/user.png[alt="Create your username and password.",width="80%"]

=== Wi-Fi

This page helps you connect to a Wi-Fi network. Choose your preferred network from the list.

image::images/initial-setup/network.png[alt="Selecting a wireless network."]
image::images/initial-setup/network.png[alt="Selecting a wireless network.",width="80%"]

If your network requires a password, you can enter it here.

image::images/initial-setup/network_password.png[alt="Entering a password for a wireless network."]
image::images/initial-setup/network_password.png[alt="Entering a password for a wireless network.",width="80%"]

=== Browser

This page lets you select Firefox or Chromium as your default internet browser. You can optionally uninstall the browser you don't set as default.

image::images/initial-setup/browser.png[alt="The Choose Browser page."]
image::images/initial-setup/browser.png[alt="The Choose Browser page.",width="80%"]

=== Raspberry Pi Connect

This page lets you enable xref:../services/connect.adoc[Raspberry Pi Connect], which provides the ability to access your Raspberry Pi remotely with no manual network configuration.

image::images/initial-setup/connect.png[alt="The Enable Raspberry Pi Connect page."]
image::images/initial-setup/connect.png[alt="The Enable Raspberry Pi Connect page.",width="80%"]

=== Software updates

Once your Raspberry Pi has internet access, this page helps you update your operating system and software to the latest versions. During the software update process, the wizard will remove the non-default browser if you opted to uninstall it in the browser selection step. Downloading updates may take several minutes.

image::images/initial-setup/update.png[alt="You can download the latest software updates during the wizard before you boot for the first time."]
image::images/initial-setup/update.png[alt="You can download the latest software updates during the wizard before you boot for the first time.",width="80%"]

image::images/initial-setup/download.png[alt="You can download the latest software updates during the wizard before you boot for the first time."]
image::images/initial-setup/download.png[alt="You can download the latest software updates during the wizard before you boot for the first time.",width="80%"]

When you see a popup indicating that your system is up to date, click **OK** to proceed to the next step.

=== Finish

At the end of the configuration wizard, click **Restart** to reboot your Raspberry Pi. Your Raspberry Pi will apply your configuration and boot to the desktop.

image::images/initial-setup/restart.png[alt="The Setup Complete dialogue prompts to restart your Raspberry Pi."]
image::images/initial-setup/restart.png[alt="The Setup Complete dialogue prompts to restart your Raspberry Pi.",width="80%"]
32 changes: 16 additions & 16 deletions documentation/asciidoc/computers/getting-started/install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,25 @@ You can install Imager in the following ways:

Once you've installed Imager, launch the application by clicking the Raspberry Pi Imager icon or running `rpi-imager`.

image::images/imager/welcome.png[alt="Raspberry Pi Imager main window."]
image::images/imager/welcome.png[alt="Raspberry Pi Imager main window.",width="80%"]

Click **Choose device** and select your Raspberry Pi model from the list.

image::images/imager/choose-model.png[alt="Raspberry Pi model selections in Imager."]
image::images/imager/choose-model.png[alt="Raspberry Pi model selections in Imager.",width="80%"]

Next, click **Choose OS** and select an operating system to install. Imager always shows the recommended version of Raspberry Pi OS for your model at the top of the list.

image::images/imager/choose-os.png[alt="Operating system selections in Imager."]
image::images/imager/choose-os.png[alt="Operating system selections in Imager.",width="80%"]

Connect your preferred storage device to your computer. For example, plug a microSD card in using an external or built-in SD card reader. Then, click **Choose storage** and select your storage device.

WARNING: If you have more than one storage device connected to your computer, _be sure to choose the correct device!_ You can often identify storage devices by size. If you're unsure, disconnect other devices until you've identified the device you want to image.

image::images/imager/choose-storage.png[alt="Storage selection options in Imager."]
image::images/imager/choose-storage.png[alt="Storage selection options in Imager.",width="80%"]

Next, click **Next**.

image::images/imager/os-customisation-prompt.png[alt="Imager prompt to open OS customisation menu."]
image::images/imager/os-customisation-prompt.png[alt="Imager prompt to open OS customisation menu.",width="80%"]

In a popup, Imager will ask you to apply OS customisation. We strongly recommend configuring your Raspberry Pi via the OS customisation settings. Click the **Edit Settings** button to open xref:getting-started.adoc#advanced-options[OS customisation].

Expand Down Expand Up @@ -80,7 +80,7 @@ The **wireless LAN** option allows you to enter an SSID (name) and password for

The **locale settings** option allows you to define the time zone and default keyboard layout for your Pi.

image::images/imager/os-customisation-general.png[alt="General settings in the OS customisation menu."]
image::images/imager/os-customisation-general.png[alt="General settings in the OS customisation menu.",width="80%"]

The **Services** tab includes settings to help you connect to your Raspberry Pi remotely.

Expand All @@ -90,11 +90,11 @@ If you plan to use your Raspberry Pi remotely over your network, check the box n

* Choose **Allow public-key authentication only** to preconfigure your Raspberry Pi for passwordless public-key SSH authentication using a private key from the computer you're currently using. If already have an RSA key in your SSH configuration, Imager uses that public key. If you don't, you can click **Run SSH-keygen** to generate a public/private key pair. Imager will use the newly-generated public key.

image::images/imager/os-customisation-services.png[alt="Services settings in the OS customisation menu."]
image::images/imager/os-customisation-services.png[alt="Services settings in the OS customisation menu.",width="80%"]

OS customisation also includes an **Options** menu that allows you to configure the behaviour of Imager during a write. These options allow you to play a noise when Imager finishes verifying an image, to automatically unmount storage media after verification, and to disable telemetry.

image::images/imager/os-customisation-options.png[alt="Options in the OS customisation menu."]
image::images/imager/os-customisation-options.png[alt="Options in the OS customisation menu.",width="80%"]

==== Write

Expand All @@ -104,19 +104,19 @@ Then, click **Yes** to apply OS customisation settings when you write the image

Finally, respond **Yes** to the "Are you sure you want to continue?" popup to begin writing data to the storage device.

image::images/imager/are-you-sure.png[alt="Confirming a reimage of a storage device in Imager."]
image::images/imager/are-you-sure.png[alt="Confirming a reimage of a storage device in Imager.",width="80%"]

If you see an admin prompt asking for permissions to read and write to your storage medium, grant Imager the permissions to proceed.

.Grab a cup of coffee or go for a walk. This could take a few minutes.
image::images/imager/writing.png[alt="Writing an image to a device in Imager."]
image::images/imager/writing.png[alt="Writing an image to a device in Imager.",width="80%"]

.If you want to live especially dangerously, you can click **cancel verify** to skip the verification process.
image::images/imager/stop-ask-verify.png[alt="Verifying an image on a device in Imager."]
image::images/imager/stop-ask-verify.png[alt="Verifying an image on a device in Imager.",width="80%"]

When you see the "Write Successful" popup, your image has been completely written and verified. You're now ready to boot a Raspberry Pi from the storage device!

image::images/imager/finished.png[alt="The screen Imager shows when it finishes writing an image to a storage device."]
image::images/imager/finished.png[alt="The screen Imager shows when it finishes writing an image to a storage device.",width="80%"]

Next, proceed to the xref:getting-started.adoc#configuration-on-first-boot[first boot configuration instructions] to get your Raspberry Pi up and running.

Expand All @@ -143,18 +143,18 @@ To launch Network Install, power on your Raspberry Pi _while pressing and holdin
* attached keyboard
* attached compatible storage device, such as an SD card or USB storage

image::images/network-install-1.png[alt="The Network Install screen."]
image::images/network-install-1.png[alt="The Network Install screen.",width="80%"]

If you haven't already connected your Raspberry Pi to the internet, connect it with an Ethernet cable.

image::images/network-install-2.png[alt="Starting Network Install."]
image::images/network-install-2.png[alt="Starting Network Install.",width="80%"]

Once you're connected to the internet, your Raspberry Pi will download Raspberry Pi installer. If the download fails, you can repeat the process to try again.

image::images/network-install-3.png[alt="Downloading Imager using Network Install."]
image::images/network-install-3.png[alt="Downloading Imager using Network Install.",width="80%"]

Once you finish downloading Raspberry Pi Installer, your Raspberry Pi will automatically start Raspberry Pi Imager. For more information about running Raspberry Pi Imager, see xref:getting-started.adoc#installing-the-operating-system[install an operating system].

image::images/network-install-4.png[alt="Choose a storage device."]
image::images/network-install-4.png[alt="Choose a storage device.",width="80%"]

For more information about Network Install configuration, see xref:raspberry-pi.adoc#http-boot[HTTP boot].
12 changes: 6 additions & 6 deletions documentation/asciidoc/computers/getting-started/setting-up.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You can use any high-quality power supply that provides the correct power mode.
|https://www.raspberrypi.com/products/micro-usb-power-supply/[12.5W Micro USB power supply]
|===

image::images/peripherals/cable-power.png[alt="Plugging a power supply into a Raspberry Pi."]
image::images/peripherals/cable-power.png[alt="Plugging a power supply into a Raspberry Pi.",width="80%"]

Plug your power supply into the port marked "POWER IN", "PWR IN", or "PWR". Some Raspberry Pi models, such as the Zero series, have output USB ports with the same form factor as the power port. Be sure to use the correct port on your Raspberry Pi!

Expand All @@ -62,7 +62,7 @@ Raspberry Pi models lack onboard storage, so you have to supply it. You can boot

All Raspberry Pi consumer models since the Raspberry Pi 1 Model A+ feature a microSD slot. Your Raspberry Pi automatically boots from the microSD slot when the slot contains a card.

image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspberry Pi."]
image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspberry Pi.",width="80%"]

==== Recommended SD cards

Expand All @@ -84,13 +84,13 @@ Other operating systems have different requirements. Check the documentation for

You can use any of the USB ports on your Raspberry Pi to connect a https://www.raspberrypi.com/products/raspberry-pi-keyboard-and-hub/[wired keyboard] or USB Bluetooth receiver.

image:images/peripherals/cable-key.png[alt="Plugging a keyboard into a Raspberry Pi."]
image:images/peripherals/cable-key.png[alt="Plugging a keyboard into a Raspberry Pi.",width="80%"]

=== Mouse

You can use any of the USB ports on your Raspberry Pi to connect a https://www.raspberrypi.com/products/raspberry-pi-mouse/[wired mouse] or USB Bluetooth receiver.

image:images/peripherals/cable-mouse.png[alt="Plugging a mouse into a Raspberry Pi."]
image:images/peripherals/cable-mouse.png[alt="Plugging a mouse into a Raspberry Pi.",width="80%"]

=== Display

Expand Down Expand Up @@ -129,7 +129,7 @@ If your Raspberry Pi has more than one HDMI port, plug your primary monitor into

Most displays don't have micro or mini HDMI ports. However, you can use a https://www.raspberrypi.com/products/micro-hdmi-to-standard-hdmi-a-cable/[micro-HDMI-to-HDMI cable] or https://www.raspberrypi.com/products/standard-hdmi-a-male-to-mini-hdmi-c-male-cable/[mini-HDMI-to-HDMI cable] to connect those ports on your Raspberry Pi to any HDMI display. For displays that don't support HDMI, consider an adapter that translates display output from HDMI to a port supported by your display.

image::images/peripherals/cable-hdmi.png[alt="Plugging a micro HDMI cable into a Raspberry Pi."]
image::images/peripherals/cable-hdmi.png[alt="Plugging a micro HDMI cable into a Raspberry Pi.",width="80%"]

=== Audio

Expand All @@ -148,4 +148,4 @@ The following Raspberry Pi models come with Wi-Fi and Bluetooth connectivity:

The "Model B" suffix indicates variants with an Ethernet port; "Model A" indicates no Ethernet port. If your Raspberry Pi doesn't have an Ethernet port, you can still connect to a wired internet connection using a USB-to-Ethernet adapter.

image::images/peripherals/cable-net.png[alt="Plugging an Ethernet cable into a Raspberry Pi."]
image::images/peripherals/cable-net.png[alt="Plugging an Ethernet cable into a Raspberry Pi.",width="80%"]
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Now that your Raspberry Pi is set up and ready to go, what's next?

Raspberry Pi OS comes with many essential applications pre-installed so you can start using them straight away. If you'd like to take advantage of other applications we find useful, click the raspberry icon in the top left corner of the screen. Select **Preferences > Recommended Software** from the drop-down menu, and you'll find the package manager. You can install a wide variety of recommended software here for free.

image::images/recommended-software.png[Opening the package manager GUI in Raspberry Pi OS]
image::images/recommended-software.png[alt="Opening the package manager GUI in Raspberry Pi OS",width="80%"]

For example, if you plan to use your Raspberry Pi as a home computer, you might find LibreOffice useful for writing and editing documents and spreadsheets. You can also make your Raspberry Pi more accessible with apps like a screen magnifier and Orca screen reader, found under Universal Access.

Expand Down
16 changes: 8 additions & 8 deletions documentation/asciidoc/computers/remote-access/vnc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ TIP: Once enabled, you can access your WayVNC configuration at `/etc/wayvnc/`.
. Select *Preferences* > *Raspberry Pi Configuration* from the menu.
+
--
image::images/raspberry-pi-configuration.png[Select Raspberry Pi Configuration from the Preferences menu in the system tray]
image::images/raspberry-pi-configuration.png[alt="Select Raspberry Pi Configuration from the Preferences menu in the system tray",width="80%"]
--
. Navigate to the *Interfaces* tab.
. Click the radio button next to *VNC* into the active position.
+
--
image::images/vnc-enable.png[In the Interfaces tab, click the VNC toggle into the active position to enable VNC.]
image::images/vnc-enable.png[alt="In the Interfaces tab, click the VNC toggle into the active position to enable VNC.",width="80%"]
--
. Click the *OK* button to save your configuration changes.

Expand Down Expand Up @@ -65,31 +65,31 @@ If you don't know the IP address of your device, see xref:remote-access.adoc#ip-
. In the "VNC server" field, enter the IP address of your Raspberry Pi.
+
--
image::images/vnc-tigervnc-enter-ip.png[Entering the Raspberry Pi's local IP address into TigerVNC,400]
image::images/vnc-tigervnc-enter-ip.png[alt="Entering the Raspberry Pi's local IP address into TigerVNC",width="60%"]
--
. Click the "Options" button. Navigate to the "Input" tab. Check the box next to "Show dot when no cursor" to ensure that you can always see a cursor in TigerVNC.
+
--
image::images/vnc-tigervnc-show-dot.png[TigerVNC option to render the cursor at all times as a dot,400]
image::images/vnc-tigervnc-show-dot.png[alt="TigerVNC option to render the cursor at all times as a dot",width="60%"]
--
. Click the "Connect" button to initiate a connection with the server.
* If TigerVNC warns you that the "Hostname does not match the server certificate", click the "Yes" button to continue.
+
--
image::images/vnc-tigervnc-cert-warning.png[TigerVNC warning about mismatched certificates,400]
image::images/vnc-tigervnc-cert-warning.png[alt=TigerVNC warning about mismatched certificates",width="60%"]
--
* If TigerVNC warns you that the "certificate has been signed by an unknown authority", click the "Yes" button to grant an exception for your Raspberry Pi.
+
--
image::images/vnc-tigervnc-cert-signer-warning.png[TigerVNC warning about certificates signed by an unknown authority,400]
image::images/vnc-tigervnc-cert-signer-warning.png[alt="TigerVNC warning about certificates signed by an unknown authority",width="60%"]
--
. When prompted for a username and password, enter your credentials.
+
--
image::images/vnc-tigervnc-username-password.png[Entering a username and password to authenticate via TigerVNC,400]
image::images/vnc-tigervnc-username-password.png[alt="Entering a username and password to authenticate via TigerVNC",width="60%"]
--
. Click the "OK" button to authenticate with the VNC server. If your credentials are correct, TigerVNC should open a window containing the desktop corresponding to your account on the Raspberry Pi. You should be able to move your mouse and keyboard to input text and interact with the desktop.
+
--
image::images/vnc-tigervnc-desktop.png[The desktop of a Raspberry Pi after successfully authenticating with TigerVNC]
image::images/vnc-tigervnc-desktop.png[alt="The desktop of a Raspberry Pi after successfully authenticating with TigerVNC",width="60%"]
--

0 comments on commit a58bf2b

Please sign in to comment.