Appliance configuration

Prepare audio hardware, the Pi 4 jack, sample rate, network and maintenance through the independent Configurator on port 8003.

Live Pi · October 2026

Jump to sample rate, Audio HAT and Pi 4 jack, network, administrator access or status and diagnostics.

Open System Maintenance on port 8003

In VinylRest Discovery, choose System Maintenance, or open http://PI-ADDRESS:8003/. This Configurator is independent of Live and its license. It remains available before activation, when audio is stopped and when the audio service cannot open a device.

Trusted LAN only: this page uses HTTP without a browser login or encryption. Keep port 8003 off the public Internet. Setting an SSH password does not password-protect the browser page.
WhereConfigureEffect
Configurator · 8003Preferred sample rateSave and restart audio briefly restarts the active Live service, not the Pi.
Configurator · 8003Audio HAT boot-driver policyPreserves the Live route; an explicit appliance reboot may be required.
Live Settings · 8001Input/output devices and stereo pairsReopens the audio session and invalidates route-specific calibration; the WebApp remains available.

Preferred sample rate

Current Pi 4 sample-rate card with 48 kHz and ordinary-click processing policy
Pi 4 running package b1-28: 48 kHz only, with ordinary DeClick, DeCrackle and NR.

Begin at 48 kHz. The saved rate is a ceiling: Live negotiates a common native rate supported by the selected input and output. Check the actual running format in the Live status bar. Input and output bit depths are negotiated independently: 24-bit capture can feed a 16-bit output, and 16-bit-only interfaces remain usable.

Hardware / rateAvailable rate choicesAutomatic DeClick policy
Pi 4 Model B48 kHz onlyOrdinary clicks only; other families remain unavailable.
Pi 5 · 44.1/48 kHz44.1, 48, 88.2 and 96 kHzAll five families at these lower rates.
Pi 5 · 88.2/96 kHzSubject to a common native device rateOrdinary clicks only to preserve processing headroom.

DeCrackle, NR, conditioning, grading and Auto remain available. The policy follows the negotiated rate, not just the saved ceiling. Pi 5 Custom family selections are described in Live Settings; they do not guarantee high-rate real-time performance.

Choose Preferred sample rate, then Save and restart audio and confirm the interruption. Live and its browser connection restart; the Configurator stays available and the Pi itself does not reboot. An administratively stopped Live service stays stopped. If a restart fails after saving, the preference may be saved without being applied: check the result and diagnostics.

When moving a card from Pi 5 to Pi 4, explicitly save 48 kHz. Merely opening or refreshing this page does not rewrite a saved preference or interrupt audio.

Audio HAT: boot driver, not playback routing

Current Audio HAT card showing automatic policy and the Pi 4 analogue jack available at plus 4 dB ALSA
No HAT is detected on this Pi 4; its jack is available. USB mixers and saved audio routes are unchanged.

Audio HAT driver policy prepares an I2S board's operating-system driver. It does not choose the input or output used by Live. After the driver is ready, choose the resulting device and connector pair in Live Settings.

Automatic (identify a supported HAT EEPROM)
Uses an exact recognized HAT identity. An unknown board is not guessed from a similar chip or name.
No Audio HAT (USB / Pi 4 jack)
Use the no-HAT policy for a USB setup or the Pi 4 analogue jack. Existing owner-managed overlay conflicts still require explicit resolution.
Exact manual model
Choose the actual board when automatic detection is insufficient. The driver must exist in the installed OS; a generic I2S option requires compatible wiring.
  1. Fit or rewire hardware only with the Pi powered off, following its manufacturer's instructions.
  2. Open the Configurator and review the detected HAT, available jack and driver-policy message.
  3. Select Automatic, No Audio HAT or the exact manual model, then choose Save hardware policy and confirm.
  4. If the result says Reboot required, finish listening, download any needed diagnostics and choose Reboot appliance explicitly. Saving hardware policy does not automatically stop Live or reboot the Pi.
  5. After startup, rediscover the Pi, check hardware status and choose its input/output endpoints in Live Settings.

Package b1-28 offers 37 choices: Automatic, no HAT and 35 manual driver profiles, with product variants grouped where they share a driver. The current b1-29 image includes the expanded choices; earlier b1-27 images required the signed b1-28 update. The screenshot shows the installed b1-28 application, not a newly flashed image.

The catalogue includes HiFiBerry, Allo, IQaudio/Raspberry Pi, JustBoom, selected AudioInjector, Audiophonics, Orchard ApplePi and documented DAC aliases. Inclusion means a supported driver-policy choice, not physical qualification of every board, Pi revision or format. Unknown hardware, absent drivers and conflicting owner overlays are reported rather than silently overwritten.

Use the correct output type: line outputs feed an amplifier or active speakers; digital outputs require a suitable receiver or DAC; amplified speaker outputs must never feed a line input. An output-only HAT still needs a separate audio input.

Pi 4 onboard analogue output

Without an active Audio HAT, the appliance enables the Pi 4 jack and prepares its verified ALSA playback level at +4 dB. This hardware gain is downstream of Live's software meters: it is not included in their output reading and does not prove the analogue output is free of clipping. USB and HAT mixers do not receive that boost.

A configured HAT normally disables the Pi 4 jack. Pi 5 has no onboard analogue jack, and HDMI audio remains disabled in the standard appliance configuration. Do not assume a playback-only device also provides a capture input.

Identity, region and Wi-Fi

Set Appliance name, timezone region/timezone and the Wi-Fi country where you use the Pi, then select Save identity. After a hostname or network change, use Discovery again if the old address stops working.

Select Scan networks to list nearby Wi-Fi networks, or enter an SSID manually. Provide the password, enable Hidden network if needed and choose Connect Wi-Fi. Leave the password empty only for an open network or one whose password is already saved. Ethernet provides a useful fallback while changing Wi-Fi.

For startup without Ethernet, use the freshly written card's vinylrest-wifi.toml file before its first boot. The Configurator displays the actual connected SSID, not the boot importer's internal connection label.

Administrator access

Administrator password and SSH public-key cards with empty credential fields
SSH setup is optional for normal browser operation. No password or key is shown.

The SSH account is vinylrest, with elevated maintenance access. A clean public image has no shared initial SSH password. Use Update password to set your own, or paste an OpenSSH public key and choose Add SSH key. Existing keys are retained; never paste a private key. Keep administrator credentials under your control.

System status and maintenance

System status listing the Pi 4 Headphones endpoint and USB Audio CODEC
Detected ALSA cards are not the same thing as Live's selected input/output route.

Refresh status reads current timezone, Wi-Fi state, SSH-key count, detected cards and preferred rate without applying changes. The preferred-rate summary is not a measurement of both active endpoint depths. Live's footer shows the running route, rate and input/processing depth; playback depth may differ. Use diagnostics and native audio-format logs when you need the details of both endpoints.

Reboot appliance interrupts audio and restarts the Pi. Download diagnostics first if a fault is present, then use Discovery to reconnect. Software updates, read-only reports and factory configuration reset are explained in Updates and recovery.