Mathieu MoranandCopilot
ae0bcc7ea8
- add deploy/readme.md with full fresh install + quick bootstrap block - update README with deploy guide link and hardware photo - fix app_network interface detection for wlan1-first setup - make dispatcher hook handle wlan0 and wlan1 - update PLAN.md with Phase 24.8 completion notes Co-authored-by: Copilot <[email protected]>
173 lines
4.4 KiB
Markdown
173 lines
4.4 KiB
Markdown
# Fresh Raspberry Pi install (deploy guide)
|
|
|
|
This guide installs `yaris-obd` on a clean Raspberry Pi so the web app auto-starts on boot and is reachable at `http://yaris.local`.
|
|
|
|
## Quick install (copy/paste)
|
|
|
|
If your Pi already has Raspberry Pi OS Bookworm and internet, this is the fastest path:
|
|
|
|
```bash
|
|
sudo adduser --disabled-password --gecos "" yaris 2>/dev/null || true
|
|
sudo usermod -aG sudo yaris
|
|
sudo apt-get update
|
|
sudo apt-get install -y \
|
|
git python3 python3-venv python3-pip \
|
|
network-manager nftables avahi-daemon dnsmasq-base
|
|
sudo systemctl enable --now NetworkManager
|
|
sudo -u yaris mkdir -p /home/yaris/app
|
|
sudo -u yaris git clone https://github.com/quoije/yaris-obd.git /home/yaris/app/yaris-obd 2>/dev/null || true
|
|
cd /home/yaris/app/yaris-obd
|
|
|
|
# REQUIRED before netwatch install:
|
|
# Create/update NetworkManager profiles named exactly:
|
|
# - home-wifi (client WiFi)
|
|
# - Hotspot (local AP, shared at 10.42.0.1/24)
|
|
# See section 4 below for exact nmcli commands.
|
|
|
|
bash deploy/install_service.sh
|
|
bash deploy/install_port_redirect.sh
|
|
bash deploy/install_netwatch.sh
|
|
bash deploy/install_video_tools.sh
|
|
# Optional:
|
|
# bash deploy/install_watchdog.sh
|
|
```
|
|
|
|
Then verify:
|
|
|
|
```bash
|
|
sudo systemctl status yaris-obd.service --no-pager
|
|
sudo systemctl status yaris-netwatch.timer --no-pager
|
|
curl -I http://127.0.0.1/
|
|
```
|
|
|
|
## 1) Base OS and assumptions
|
|
|
|
- Raspberry Pi OS Bookworm (Lite is fine)
|
|
- Internet access for package install
|
|
- User account named `yaris`
|
|
- Repo path: `/home/yaris/app/yaris-obd` (required by `deploy/yaris-obd.service`)
|
|
|
|
If the `yaris` user does not exist yet:
|
|
|
|
```bash
|
|
sudo adduser yaris
|
|
sudo usermod -aG sudo yaris
|
|
```
|
|
|
|
## 2) Install system packages
|
|
|
|
```bash
|
|
sudo apt-get update
|
|
sudo apt-get install -y \
|
|
git python3 python3-venv python3-pip \
|
|
network-manager nftables avahi-daemon dnsmasq-base
|
|
```
|
|
|
|
Enable NetworkManager on boot:
|
|
|
|
```bash
|
|
sudo systemctl enable --now NetworkManager
|
|
```
|
|
|
|
## 3) Clone the project
|
|
|
|
```bash
|
|
sudo -u yaris mkdir -p /home/yaris/app
|
|
sudo -u yaris git clone https://github.com/quoije/yaris-obd.git /home/yaris/app/yaris-obd
|
|
cd /home/yaris/app/yaris-obd
|
|
```
|
|
|
|
## 4) Create required NetworkManager profiles
|
|
|
|
`deploy/install_netwatch.sh` expects two profiles to already exist:
|
|
|
|
- `home-wifi` (normal client connection)
|
|
- `Hotspot` (local AP for phones/laptops in the car)
|
|
|
|
### 4a) Home WiFi profile (edit SSID/password)
|
|
|
|
```bash
|
|
sudo nmcli connection add \
|
|
type wifi \
|
|
con-name home-wifi \
|
|
ifname wlan1 \
|
|
ssid "<HOME_WIFI_SSID>" \
|
|
wifi-sec.key-mgmt wpa-psk \
|
|
wifi-sec.psk "<HOME_WIFI_PASSWORD>" \
|
|
connection.autoconnect yes \
|
|
connection.autoconnect-priority 30
|
|
```
|
|
|
|
### 4b) Local hotspot profile (edit password)
|
|
|
|
```bash
|
|
sudo nmcli connection add type wifi con-name Hotspot ifname wlan1 ssid yaris-obd
|
|
sudo nmcli connection modify Hotspot \
|
|
802-11-wireless.mode ap \
|
|
802-11-wireless.band bg \
|
|
wifi-sec.key-mgmt wpa-psk \
|
|
wifi-sec.psk "<HOTSPOT_PASSWORD>" \
|
|
ipv4.method shared \
|
|
ipv4.addresses 10.42.0.1/24 \
|
|
connection.autoconnect yes \
|
|
connection.autoconnect-priority 10
|
|
```
|
|
|
|
> If you do not use the TP-Link T3U (`wlan1`), switch `ifname wlan1` to `ifname wlan0` above and update `WLAN`/`WLAN_FB` in `deploy/install_netwatch.sh` before running it.
|
|
|
|
## 5) Run deploy installers (in order)
|
|
|
|
From `/home/yaris/app/yaris-obd`:
|
|
|
|
```bash
|
|
bash deploy/install_service.sh
|
|
bash deploy/install_port_redirect.sh
|
|
bash deploy/install_netwatch.sh
|
|
bash deploy/install_video_tools.sh
|
|
```
|
|
|
|
Optional (recommended on real hardware):
|
|
|
|
```bash
|
|
bash deploy/install_watchdog.sh
|
|
```
|
|
|
|
## 6) Verify
|
|
|
|
```bash
|
|
sudo systemctl status yaris-obd.service --no-pager
|
|
sudo systemctl status yaris-netwatch.timer --no-pager
|
|
sudo nft list ruleset | grep -n "dport 80"
|
|
curl -I http://127.0.0.1/
|
|
```
|
|
|
|
Expected:
|
|
|
|
- `yaris-obd.service` is `active (running)`
|
|
- `yaris-netwatch.timer` is active
|
|
- nftables has redirect from port `80` to `5000`
|
|
- local HTTP on port 80 returns 200/302
|
|
|
|
Then test from another device:
|
|
|
|
- `http://yaris.local`
|
|
- if mDNS is not available on that client, try `http://10.42.0.1`
|
|
|
|
## 7) Updating later
|
|
|
|
```bash
|
|
cd /home/yaris/app/yaris-obd
|
|
git pull --ff-only
|
|
bash deploy/install_service.sh
|
|
sudo systemctl restart yaris-obd.service
|
|
```
|
|
|
|
If deploy files changed, rerun the corresponding installer script(s) (`install_netwatch.sh`, `install_port_redirect.sh`, etc.).
|
|
|
|
## 8) Useful diagnostics
|
|
|
|
```bash
|
|
bash /home/yaris/app/yaris-obd/scripts/diagnose.sh
|
|
bash /home/yaris/app/yaris-obd/scripts/diagnose.sh --fix
|
|
```
|