Add Headless Operatin docs page.
This commit is contained in:
Robin E. R. Davies
Vendored
+4
@@ -107,16 +107,20 @@
|
||||
},
|
||||
"cSpell.words": [
|
||||
"Alsa",
|
||||
"distros",
|
||||
"flac",
|
||||
"Guitarix",
|
||||
"hostapd",
|
||||
"Hotspot",
|
||||
"Hotspots",
|
||||
"invada",
|
||||
"jmap",
|
||||
"kconfig",
|
||||
"Lilv",
|
||||
"midiclip",
|
||||
"midisong",
|
||||
"mlmodel",
|
||||
"Netplan",
|
||||
"Pedalboard",
|
||||
"pipedal",
|
||||
"pipedal_0",
|
||||
|
||||
@@ -49,6 +49,7 @@ https://github.com/user-attachments/assets/9a9fd0c6-78fc-4284-8b44-6a1929c00cc6
|
||||
### [Installing PiPedal](https://rerdavies.github.io/pipedal/Installing.html)
|
||||
### [PiPedal on Ubuntu](https://rerdavies.github.io/pipedal/Ubuntu.html)
|
||||
|
||||
### [Headless Operation](https://rerdavies.github.io/pipedal/HeadlessOperation.html)
|
||||
### [Configuring PiPedal After Installation](https://rerdavies.github.io/pipedal/Configuring.html)
|
||||
### [An Intro to Snapshots](https://rerdavies.github.io/pipedal/Snapshots.html)
|
||||
### [Choosing a USB Audio Adapter](https://rerdavies.github.io/pipedal/ChoosingAUsbAudioAdapter.html)
|
||||
|
||||
@@ -9,6 +9,7 @@
|
||||
|
||||
#### [Installing PiPedal](Installing.md)
|
||||
#### [PiPedal on Ubuntu](Ubuntu.md)
|
||||
#### [Headless Operation](HeadlessOperation.md)
|
||||
#### [Configuring PiPedal After Installation](Configuring.md)
|
||||
#### [An intro to Snapshots](Snapshots.md)
|
||||
#### [Choosing a USB Audio Adapter](ChoosingAUsbAudioAdapter.md)
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
page_icon: img/headless.jpg
|
||||
icon_width: 120px
|
||||
icon_float: right
|
||||
---
|
||||
## Headless Operation
|
||||
|
||||
{% include pageIcon.html %}
|
||||
|
||||
## Running Headless
|
||||
|
||||
To get the best possible audio latency, your PiPedal server should run headless. GPU activity interferes with low-latency audio. Drawing to the screen (or even moving the mouse) can cause audio underruns. This does not mean that you cannot use a desktop install; but it does mean that you should not be using the server's desktop when using PiPedal. Use a browser on a remote machine, or use a phone or tablet to control PiPedal. PiPedal is very much designed on the expectation that you will be using a remote device to control it.
|
||||
|
||||
It is not entirely clear why GPUs don't play well with realtime low-latency audio. It's probably not caused by interrupts, but may be caused by contention for system memory and various system buses. Or perhaps by graphics drives that cheat a bit in order to get better benchmark scores. If you are running a very powerful PC with a GPU that doesn't share system memory for its framebuffer, you may be able to run a desktop while using PiPedal; but if you are not getting the latency you think you should, try going back to headless operation. The difference is dramatic. A system that may struggle to achieve 15ms latency with a desktop running (256x3 buffer configuration), should easily be able to achieve sub-5ms latency (32x3 buffer configuration) when running headless. As a point of reference, 10ms latency is generally considered the maximum threshold for usable realtime audio that doesn't feel spongy and unpleasant.
|
||||
|
||||
If you are running on a Raspberry Pi, it doesn't seem that strange run the Pi without a monitor connected. If you are using a laptop or desktop computer, running Ubuntu 24.x, this may seem a bit odd. But it matters! Running headless makes the difference between ordinary and extra-ordinary. You may want to consider purchasing a dedicated host for PiPedal—perhaps, a tiny N95, N100 or N150 micro-pc, or, of course, a Raspberry Pi 5. It's perfectly fine to run PiPedal on a desktop, or laptop. But just make sure you are not using the GPU when you run PiPedal.
|
||||
|
||||
Headless, in this context means that nothing is using the GPU. On a Raspberry Pi, it is sufficient to just disconnect the HDMI cables, and not be using a remote desktop connection. It is uncertain whether Ubuntu will stop using the GPU if there is an active desktop that is (for example) updating status indicators on the status bar. If in doubt, try disabling automatic login. The system will then stop at the login screen, which does not do any drawing until you start typing credentials. Configuring your PiPedal server to use a text-mode interface instead of a graphical interface would, of course, be perfect; but it seems unnecessarily inconvenient. Personally, I prefer to have a graphical desktop available if I need it to tinker with the system, or run software updates. On an Ubuntu server install, there is no graphical desktop, so this is not a problem. But see the section in [PiPedal on Ubuntu](Ubuntu.md) about configuring Ubuntu Server network services before you choose an Ubuntu Server install.
|
||||
|
||||
|
||||
--------
|
||||
[<< PiPedal on Ubuntu](Ubuntu.md) | [Up](Documentation.md) | [Configuring PiPedal after Installation >>](Configuring.md)
|
||||
|
||||
+35
-6
@@ -11,13 +11,42 @@ PiPedal will run on Ubuntu 24.04, and 24.10 (both aarch64 and amd64/x64) as well
|
||||
|
||||
For best audio latency, you should not use PiPedal with an active desktop. See the Running Headless section below.
|
||||
|
||||
You might want to consider purchasing a tiny N95, N100 or N150 micro-pc on which to run PiPedal. They are cheap, provide plenty of CPU power, and are exactly the sort of hardware you need to run PiPedal at a gig, or away from home where you don't have access to a wi-fi network, or a monitor, or a keyboard. N100-series micro-pcs are in many ways preferrable to a Raspberry Pi 5. They provide significantly more compute power, and cost only slightly more.
|
||||
You might want to consider purchasing a tiny N95, N100 or N150 micro-pc on which to run PiPedal. They are cheap, provide plenty of CPU power, and are exactly the sort of hardware you need to run PiPedal at a gig, or away from home where you don't have access to a wi-fi network, or a monitor, or a keyboard. N100-series micro-pcs are in many ways preferable to a Raspberry Pi 5. They provide significantly more compute power, and cost only slightly more.
|
||||
|
||||
PiPedal runs as a systemd service, rather than as a desktop application. By design, it is an IoT sort of device. You plugin in (or power on) your computer, and PiPedal starts up automatically. This may seem a bit odd on a laptop or a desktop computer; but it makes a great deal of sense if you are using a Raspberry Pi or tiny N100 mini pc to host PiPedal. And it makes a great deal of sense when you are using PiPedal onstage without access to a keyboard or a monitor. Just clip your phone onto your microphone stand, and you're set!
|
||||
|
||||
## The Website port on Ubuntu 24.x
|
||||
|
||||
On Ubuntu 24.x the PiPedal web server usually runs on port 81, rather than the default port 80. This is because a clean install of Ubuntu 24.x comes with the Apache web server installed and configured to run on port 80. The PiPedal debian package installer will detect this, and will automatically configure PiPedal to run on port 81 instead.
|
||||
|
||||
You can connect to the PiPedal web interface using these URLs:
|
||||
|
||||
```
|
||||
http://localhost:81 (local connection only.)
|
||||
http://<server's IP address>:81
|
||||
http://<server's machine name>.local:81
|
||||
```
|
||||
|
||||
For example, I can connect to my PiPedal server hosted on Ubuntu 24.x using the following URL:
|
||||
|
||||
```
|
||||
http://rohan.local:81
|
||||
```
|
||||
|
||||
When connecting to PiPedal over a PiPedal Auto-Hotspot connection, you can use the following URL:
|
||||
|
||||
```
|
||||
http://172.23.0.2:81
|
||||
```
|
||||
|
||||
If you would prefer to use different port, you can change the port number by running the following command:
|
||||
|
||||
```
|
||||
sudo pipedalconfig --port <new port number>
|
||||
```
|
||||
## Configuring a preempt=full Kernel on Ubuntu 24.x
|
||||
|
||||
By default, Ubuntu installs a PREEMT_DYNAMIC kernel, configured to run with volutary preemption. PREEMPT_DYNAMIC/preempt=voluntary kernels are not capable of supporting real-time audio. To run low-latency realtime audio on Ubuntu, you must reconfigure Ubuntu to use a PREEMPT_DYNAMIC/preempt=full kernel. The PiPedal installer includes a convenient command-line utility that allows you to make the change without having to do painful editing of intimidating system files. Although this is a relatively harmless change, it seemed inappropriate to reconfigure the kernel in the Pipedal package installer. Run the following command-line command after you have installed PiPedal:
|
||||
By default, Ubuntu installs a PREEMPT_DYNAMIC kernel, configured to run with voluntary preemption. PREEMPT_DYNAMIC/preempt=voluntary kernels are not capable of supporting real-time audio. To run low-latency realtime audio on Ubuntu, you must reconfigure Ubuntu to use a PREEMPT_DYNAMIC/preempt=full kernel. The PiPedal installer includes a convenient command-line utility that allows you to make the change without having to do painful editing of intimidating system files. Although this is a relatively harmless change, it seemed inappropriate to reconfigure the kernel in the Pipedal package installer. Run the following command-line command after you have installed PiPedal:
|
||||
|
||||
```
|
||||
pipedal_kconfig
|
||||
@@ -25,18 +54,18 @@ By default, Ubuntu installs a PREEMT_DYNAMIC kernel, configured to run with volu
|
||||
|
||||
and then select Preempt=full. Switching between PREEMPT_DYNAMIC kernels is a configuration-only change, and does not install new components. The switch actually takes place at runtime. Astonishingly, you do not even need to reboot!
|
||||
|
||||
Full realtime kernels (RT_PREEMPT) may provide slightly better realtime audio than a PREEMPT_DYNAMIC/preempt=full kernel, but the PREEMPT_DYNAMIC kernel should be perfectly adequate. As a point of reference, current versions of Ubuntu Studio uses a PREEMPT_DYNMAIC/preempt=full kernel, and the maintainers of Ubuntu Studio consciously chose to not install an RT_PREEMPT kernel by default. If you are having problems with intermittent audio dropouts that occur very infrequently, you may want to try an RT_PREEMPT kernel instead. A pre-built Ubuntu RT_PREEMPT kernel can be installed using `apt` but is only available if you have an Ubuntu Pro subscription. Ubuntu Pro is free for non-commercial use.
|
||||
Full realtime kernels (RT_PREEMPT) may provide slightly better realtime audio than a PREEMPT_DYNAMIC/preempt=full kernel, but the PREEMPT_DYNAMIC kernel should be perfectly adequate. As a point of reference, current versions of Ubuntu Studio uses a PREEMPT_DYNAMIC/preempt=full kernel, and the maintainers of Ubuntu Studio consciously chose to not install an RT_PREEMPT kernel by default. If you are having problems with intermittent audio dropouts that occur very infrequently, you may want to try an RT_PREEMPT kernel instead. A pre-built Ubuntu RT_PREEMPT kernel can be installed using `apt` but is only available if you have an Ubuntu Pro subscription. Ubuntu Pro is free for non-commercial use.
|
||||
|
||||
## Support for WIFI Auto-Hotspots on Ubuntu Server
|
||||
|
||||
The following information applies when installing PiPedal on Ubuntu Server 24.0x only. This information does not apply
|
||||
to Unbuntu Desktop installs or to Raspberry Pi OS or Raspberry Pi OS Lite installs, which use the Network Manager TCP/IP stack by default.
|
||||
to Ubuntu Desktop installs or to Raspberry Pi OS or Raspberry Pi OS Lite installs, which use the Network Manager TCP/IP stack by default.
|
||||
|
||||
PiPedal's Auto-Hotspot feature only works on Linux systems that are using the Network Manager network services stack.
|
||||
Ubuntu Server 24.x (and probably other server-specific installs on other Debian distros) uses the Netplan network services stack instead. It does so because the Netplan network stack is the preferred network stack when managing farms of cloud servers.
|
||||
|
||||
It's easy enough to reconfigure Ubuntu Server to run the Network Manager network stack instead. However you should be
|
||||
aware that Netplan TCP/IP configuration settings will not be migrated to Network Manager. If you perform this step on a server on which changes have beeen made to Netplan configuration files, you will lose those configuration changes, and will need to reimplement them in Network Manager. If you are
|
||||
aware that Netplan TCP/IP configuration settings will not be migrated to Network Manager. If you perform this step on a server on which changes have been made to Netplan configuration files, you will lose those configuration changes, and will need to reimplement them in Network Manager. If you are
|
||||
using a default Netplan configuration (or are working with a clean install), then the default Network Manager configuration should work without problems. On a clean install, or for ordinary home use, switching network stacks is pretty low risk.
|
||||
|
||||
To reconfigure Ubuntu Server to use the Network Manager network stack (and therefore enable PiPedal's Auto-Hotspot feature), run the following command:
|
||||
@@ -55,5 +84,5 @@ Headless, in this context means: nothing is using the GPU. On a Raspberry Pi, it
|
||||
|
||||
|
||||
--------
|
||||
[<< Installing PiPedal](Installing.md) | [Up](Documentation.md) | [Configuring PiPedal after Installation >>](Configuring.md)
|
||||
[<< Installing PiPedal](Installing.md) | [Up](Documentation.md) | [Headless Operation >>](Headless.md)
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 62 KiB |
Reference in New Issue
Block a user