Cockpit is an application from cockpit-project.org for the configuration of Linux servers. Cockpit offers a user-friendly graphical interface that enables authenticated users to execute any configurations and commands on a device via a secure connection. Network configuration, user administration, status and log views can be managed via a browser. Cockpit, also known as Web Console, is an open source software project sponsored by Red Hat and published under the GNU Lesser General Public License (LGPL).

Cockpit for Revolution Pi is available from the RevPi Bookworm Image upwards and replaces the application RevPi Status, also known as Webstatus, which was used up to the RevPi Bullseye Image.

In addition to the standard server configuration, the plugins Revolution Pi and Node-RED are available. They enable the basic configuration of your RevPi base module and a simple activation or deactivation of the services installed.

For the module configuration of the Revolution Pi system, i.e. a RevPi base module with expansion modules, use the PiCtory application or configure directly within your development environment, such as CODESYS.

Start Cockpit #

RevPi Bookworm Image oder höher ist auf dem RevPi installiert.

▷ Establish a network connection between the RevPi and your PC.

▷ Open a web browser.

▷ Call up Cockpit via the web browser with revpi[serial number].local
You can find the serial number of the RevPi on the front of the housing next to the QR code.
Alternatively, you can enter the IP address of the RevPi in the web browser.

❯ The warning NET::ERR_CERT_AUTHORITY_INVALID may appear in the browser.

▷ Accept the security exception to continue with the login.

❯ The login screen for Cockpit appears.

▷ Log in with user name pi and the device password.
You will find the device password on the sticker on the side of the RevPi housing.

❯ Cockpit opens in Limited access mode.

▷ Select Limited access in the top main navigation bar to switch to Administrative access mode.

❯❯ With the elevated rights of this administrative access you can now configure the RevPi.

Configuration #

▷ Select RevPi Configuration in the Cockpit menu.

RevPi Apps #

RevPi Apps are available applications on your RevPi.

  • PiCtory is the RevPi application used for module configuration of your Revolution Pi system, i.e. for a RevPi base module with expansion modules, see: PiCtory.

  • Node-RED is a graphical flow-based tool for connecting devices and automating workflows, see Node-RED.

Runtimes #

RevPiPyLoad is a Python-based runtime environment for RevPi. The runtime manages real-time industrial automation tasks and runs user-defined Python scripts.

▷ Activate RevPiPyLoad if you want to run user-defined Python scripts on your RevPi.

Note

Ensure your scripts are compatible with RevPiPyLoad before enabling.

See also:

System Configuration #

Boot to GUI #

In Desktop Mode, you can boot the RevPi directly into a graphical user interface as an alternative to the terminal.

  • The GUI uses more RAM and processing power than a terminal.

  • Recommended for users unfamiliar with command-line operations.

Swap / page file #

Swap memory acts as virtual RAM. RAM data is stored on the eMMC permanent memory.

▷ Enable swap to prevent system crashes when RAM is exhausted.

▷ Disable swap when performance is low.

Avahi (ZeroConf) #

Avahi enables ZeroConf networking, allowing easy discovery of network services.

  • Accessing the device using hostname.local instead of an IP address.

  • Automatically discovering printers and file shares.

Note

You cannot disable Avahi while connected to Cockpit via an Avahi address (.local). If you need to disable it, use the command line or connect Cockpit via the device’s IP address instead.

Set clock from NTP-Server #

Synchronizes the RevPi system time with an NTP server for accuracy.

  • Ensures accurate timestamps for logs and scheduled tasks.

  • Prevents time drift on devices without a real-time clock.

An active internet connection is required to synchronize with NTP servers.

SSH daemon #

The SSH daemon manages the SSH connections to your RevPi.

▷ Enable SSH to allows remote terminal access to the RevPi over a network.

▷ Use strong passwords or SSH key-based authentication.

▷ Use ssh pi@revpi[serialnumber].local to connect via SSH.

▷ Disable SSH if remote access is not required.

WLAN and BT #

Configuration of the built-in wireless connection module. This applies to:

WLAN #

▷ Enable toggle to activate WLAN.

▷ Select the WLAN country code. Choose the country where you are using the device.

  • Setting the correct country helps prevent connection issues and improves network reliability.

  • Different countries allow different WiFi channels and signal strengths.

▷ Select antenna for wireless connectivity.

  • External antenna (SMA): provides better signal reception in challenging environments. Connect a RP-SMA WLAN antenna at the RP-SMA socket of the RevPi.

  • Internal antenna: uses the built-in antenna.

❯❯ WLAN is activated.

▷ Disable WLAN to reduce power consumption and increase security.

BT #

▷ Enable BT for using Bluetooth peripherals such as keyboards or audio devices for your RevPi.

▷ Disable BT to reduce power consumption and increase security.

Accounts and Device Password Management #

Use the Cockpit user management to change the RevPi device password or to create new accounts.

▷ Open Cockpit menu Accounts.

▷ Open the three-dot menu ⁝ for user pi and select Edit user.

▷ Select Set password.

▷ Enter the new password twice and confirm with Set password.

❯❯ The device password for user pi has been changed.

Important

Do not delete user accounts pi or root, otherwise it will no longer be possible to log in.

Change Language for Cockpit #

The following languages are supported for the Cockpit RevPi Applications:

  • English

  • German

▷ Open drop-down menu Sessions in the top main navigation bar.

▷ Select Display language to change the language for Cockpit.

Node-RED #

Node-RED is a graphical, flow-based tool for connecting devices and automating workflows. With RevPi Nodes Runtime, specific nodes in the Node-RED editor can be used for the inputs and outputs of the RevPi.

Installing Packages for Node-RED #

▷ Open the Cockpit menu Revolution Pi.

▷ Select Install next to the RevPi App Node-RED to install packages revpi-nodered and noderedrevpinodes-server.

▷ Select Configure to switch to Node-RED menu.

Starting Node-RED #

The Cockpit menu Node-RED includes an integrated user management for authenticated access to the Node-RED editor.

▷ Open the Cockpit menu Node-RED.

The colored dot indicates the status of the RevPi Node-RED service:

  • red: service inactive

  • yellow: service initializing

  • green: service active

▷ Add one or more Node-RED users with a secure password and a role (Read or All access rights).

  • All Node-RED users have access to the same Node-RED work environment for this RevPi.

  • Node-RED users are independent from the user accounts for your Revolution Pi system.

▷ Select Apply Settings.

▷ Enable the main toggle at the top right to initialize RevPi Node-RED service.

▷ Select Open Node-RED or use App URL to access Node-RED editor.

Important

You can use Node-RED without authentification, but in this case, anyone with network access to your RevPi can access the Node-RED editor.

See also:

Expert Mode #

Expert Mode for experienced users enables direct editing of the Node-RED settings.js using the integrated code editor.

Important
  • Incorrect changes to the settings.js file may prevent Node-RED from starting properly.

  • Do not modify the options uiHost and uiPort as they are managed externally.

Use Load Node-RED defaults to restore the default version of the settings.js file if needed.

Changes made in the code editor are preserved when leaving Expert Mode.

RevPi Nodes Runtime #

With the RevPi Nodes runtime environment, specific nodes in the Node-RED editor can be used for the inputs and outputs of the RevPi. This feature is enabled automatically because it is required for using RevPi nodes in Node-RED.

Reboot RevPi #

▷ Open Cockpit menu Overview.

▷ Select Reboot at the top right.

▷ Select a Delay for the reboot.

▷ Select Reboot.

❯ The RevPi is shut down and will reboot. The power LED flashes red.

❯ The power LED lights up green as soon as the RevPi is ready for operation.

▷ Select Reconnect and log in.

Shut Down RevPi #

▷ Open Cockpit menu Overview.

▷ Open the dropdown next to Reboot and select Shutdown.

▷ Select a Delay for the shutdown.

▷ Select Shutdown.

❯ The RevPi is shut down and disconnected from Cockpit.

To restart the RevPi, the power supply must be disconnected and reconnected.

Open Terminal #

▷ Select Terminal in the Cockpit menu.

❯❯ Opens an integrated, fully functional terminal that can be used to enter commands directly.

Installing Updates #

▷ Open Cockpit menu Software updates.

▷ Select Check for updates (arrow) top right.

▷ Select Install all updates to perform the available updates.

Alternatively, install updates via the terminal:

▷ Select Terminal in the Cockpit menu.

▷ Enter the following command to read and update all available package lists:

sudo apt update

▷ Enter the following command to install all available updates:

sudo apt upgrade

Retrieve Network Information #

▷ Open Cockpit menu Networking to call up network information such as IP address and network name.

Create SOS Report #

The SOS report collects system information that can help diagnose problems. This information is only stored on the system and can then be downloaded.

▷ Open Cockpit menu Diagnostic reports.

▷ Select Run report.

▷ Define a report label as the name for the report and, if necessary, a password (encryption passphrase).

▷ Select Run report.

❯ An SOS report is created.

▷ Select Download to download the SOS Report.