Skip to content

docs: Add networking page - #266

Open
romandariana wants to merge 1 commit into
mainfrom
dev_networking
Open

docs: Add networking page#266
romandariana wants to merge 1 commit into
mainfrom
dev_networking

Conversation

@romandariana

Copy link
Copy Markdown
Contributor

Kuiper networking was undocumented apart from the SSH and VNC access steps in use-kuiper-image. Add a networking page covering the default configuration and the common tasks around it: DHCP, direct board-to-PC connections, static addressing, Wi-Fi, hostname and mDNS discovery, reaching IIO devices over the network, and troubleshooting.

Document the two NetworkManager profiles installed by 03.system-tweaks/04.network-tweaks. eth0 tries DHCP for 5 seconds and falls back to a link-local address, so connecting a board straight to a PC needs no configuration at all. Static addressing is described through nmcli, as the image is managed entirely by NetworkManager.

Move the hostname and MAC section out of use-kuiper-image, since hostname is what drives mDNS discovery, and cross-reference the first-boot access steps that stay there.

Pull Request Description

Please replace this with a detailed description and motivation of the changes.
You can tick the checkboxes below with an 'x' between square brackets or just check them after publishing the PR.
If this PR contains a breaking change, list dependent PRs and try to push all related PRs at the same time.

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

  • I have performed a self-review of the changes
  • I have commented my code, at least hard-to-understand parts
  • I have built Kuiper Linux image with the changes
  • I have tested new image in hardware, on relevant boards
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe etc)

@romandariana romandariana self-assigned this Aug 6, 2026
@romandariana romandariana added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 6, 2026

@gastmaier gastmaier left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using ip addr instead of ifconfig looks good, i see systemd, hostctl too, if it is fully using modern linux utils, it is approved by me.

@romandariana

Copy link
Copy Markdown
Contributor Author

Kuiper networking was undocumented apart from the SSH and VNC access
steps in use-kuiper-image. Add a networking page covering the default
configuration, DHCP, direct board-to-PC connections, static addressing,
Wi-Fi, hostname and mDNS discovery, and IIO over the network.

eth0 tries DHCP for 5 seconds and falls back to a link-local address, so
connecting a board straight to a PC needs no configuration at all.
Static addressing is described through nmcli, with the
enable_static_ip.sh and enable_dhcp.sh helper scripts documented
alongside it.

Move the hostname and MAC section out of use-kuiper-image, since
hostname is what drives mDNS discovery.

Signed-off-by: Alisa-Dariana Roman <alisa.roman@analog.com>
Assisted-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants