Skip to content

Update VILLASnode requirements documentation #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stv0g merged 2 commits into from
Oct 16, 2025
Merged

Update VILLASnode requirements documentation #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d1c7bc
cleanup: Remove unused terminal recording
pjungkamp Sep 9, 2025
3aeb51c
Update VILLASnode requirements
pjungkamp Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/node/development/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Please follow our [contribution guide](./contributing.md) when creating pull req

## Programming Paradigm

VILLASnode is currently written in C/C++ using the ISO C11 and C++17 standards while following an object oriented programming paradigm.
VILLASnode is currently written in C/C++ using the ISO C11 and C++20 standards while following an object oriented programming paradigm.

Main _classes_ in VILLASnode are:
- [`struct villas::node::Sample`](https://github.com/VILLASframework/node/blob/master/include/villas/sample.hpp)
Expand Down
6 changes: 0 additions & 6 deletions docs/node/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@ Please make sure that your system fulfills the [requirements](requirements.md) b
## From sources {#source}

VILLASnode can be compiled from source using [CMake](http://cmake.org).
This process has been tested with the following Linux distributions:

- Fedora 42
- Debian 12 (Bookworm)
- Ubuntu 24.04 (Noble Numbat)
- Rocky Linux 9.3

### Prerequisites

Expand Down
12 changes: 6 additions & 6 deletions docs/node/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_position: 2

This page documents the requirements for running VILLASnode.


## Hardware

We recommend a recent 64-bit Intel x86_64 Xeon server with at least 8 CPU cores in combination with a professional Intel network card providing multiple independent Ethernet ports.
Expand All @@ -32,22 +33,21 @@ VILLASnode has also been tested on various other systems:
We explicitly advise against using virtualized environments for anything apart from testing and development due to unpredictable latencies and bad real-time performance.
:::


## Operating system

VILLASnode is regularly tested on the following operating systems:

- Fedora 34 (recommended)
- Debian 11.2 - Bullseye
- CentOS / RHEL / RockyLinux 8
- Alpine 3.13
- Ubuntu 20.04
- Fedora 42
- Debian 12 (Bookworm)
- RockyLinux 9.6 (Blue Onyx)
- Ubuntu 24.04 (Noble Numbat)

Better real-time performance can be achieved by using an optimized system configuration. Please take a look at the [Tuning](tuning.md) page for details.

:::caution
Disable any firewall on your system or configure it accordingly to work with the protocols used by VILLASnode. An improperly configured firewall is the most common issue reported while using VILLASnode!


E.g. on a RHEL/CentOS/RockyLinux or Fedora system:
```shell
systemctl disable --now firewalld
Expand Down
Loading