Updating docs to include new Controller onboarding flow, certificates, and video captions.

This commit is contained in:
rolobio 2026-03-22 19:47:03 -06:00
parent f8164d9053
commit d2415ae19f
11 changed files with 142 additions and 24 deletions

View file

@ -1,16 +1,36 @@
# Getting Started
## Finish WROLPi Installation
## First Boot
To finish your WROLPi installation follow these steps:
When a WROLPi boots for the first time, it generates a temporary HTTPS certificate and starts the Controller
fallback UI. Your browser will be redirected to the Controller where you can complete the onboarding process.
1. Modify fstab to [mount your external drive(s)](external-drives.md). In the example below, `/dev/sda1` will be mounted
to `/media/wrolpi`
1. `echo '/dev/sda1 /media/wrolpi auto defaults,nofail 0 0' | sudo tee -a /etc/fstab`
2. Finish the installation with the repair script: `sudo bash /opt/wrolpi/repair.sh`
3. Reboot: `sudo reboot`
4. After reboot, browse to `http://wrolpi.local` or `http://127.0.0.1` on the WROLPi itself.
5. [Refresh your files](../modules/files/index.md#refreshing)
### Onboarding
1. Open a browser to your WROLPi's address (e.g. `https://wrolpi.local` or `https://127.0.0.1` on the WROLPi
itself).
2. Accept the self-signed certificate warning in your browser. This is expected on a fresh install.
3. The Controller will display the **Welcome to WROLPi** screen with your available drives.
![onboarding-drive-selection.png](onboarding-drive-selection.png)
4. Select the drive you want to use as your WROLPi media drive.
5. If the drive contains an existing WROLPi configuration, you will be asked to confirm. Click **Set Up This
Drive** to proceed, or **Choose Different Drive** to go back.
![onboarding-confirm-drive.png](onboarding-confirm-drive.png)
6. WROLPi will mount the drive and start the repair script automatically. You will see a **Repair WROLPi
Running** banner at the top of the page.
![onboarding-repair-running.png](onboarding-repair-running.png)
> This will take about 15 minutes on a Raspberry Pi 4.
7. Once repair completes, all services will start and you will be redirected to the main UI.
After onboarding, you should install the [HTTPS certificate](certificates.md) on your devices to avoid the
browser warning on future visits.
# Creating a new WROLPi
@ -23,16 +43,16 @@ on a new Raspberry Pi.
1. Plug in your SD card, find its device path with: `sudo blkid`
2. Extract and copy the WROLPi image to your drive (/dev/sdb in this example):
* `xzcat WROLPi-v0.10-aarch64-desktop.img.xz | sudo dd of=/dev/sdb status=progress`
* `xzcat WROLPi-v0.19-aarch64-desktop.img.xz | sudo dd of=/dev/sdb status=progress`
### Image an SD Card on Windows
1. Copy the WROLPi image to your micro SD card using [Balena Etcher](https://www.balena.io/etcher)
1. Copy the WROLPi image to your micro SD card using [Raspberry Pi Imager](https://www.raspberrypi.com/software/)
### First Boot
1. Unplug your Raspberry Pi
2. Insert the micro SD card from step 2 into your Raspberry Pi
2. Insert the micro SD card into your Raspberry Pi
3. Connect any peripherals to your Raspberry Pi.
4. Boot your Raspberry Pi.
5. Choose your Country/Language/Timezone.
@ -43,13 +63,8 @@ on a new Raspberry Pi.
10. Skip "Update Software".
11. Restart.
12. Login using the user you created above.
13. Launch the Terminal application
1. Modify fstab to mount your external drive to **/media/wrolpi**
* `echo '/dev/sda1 /media/wrolpi auto defaults,nofail 0 0' | sudo tee -a /etc/fstab`
2. Finish the installation with the repair script:
* `/opt/wrolpi/repair.sh`
3. Reboot: `sudo reboot`
14. Join the Hotspot, browse to https://wrolpi.local or, the IP address of your WROLPi!
13. A browser will open automatically. Follow the [Onboarding](#onboarding) steps above to select your drive and
complete the installation.
## Debian
@ -62,8 +77,6 @@ on a new Debian computer.
2. Install Debian 12.
3. Unplug the thumb-drive after the installation has completed
4. Login as the user you created during installation.
5. Switch to the root user: `su -`
6. Finish the installation with the repair script: `sudo bash /opt/wrolpi/repair.sh`
7. Reboot: `sudo reboot`
8. Join the Hotspot or browse to `http://wrolpi.local` or the IP address of your WROLPi!
9. [Refresh your files](../modules/files/index.md#refreshing)
5. Reboot: `sudo reboot`
6. A browser will open automatically. Follow the [Onboarding](#onboarding) steps above to select your drive and
complete the installation.