View source for Hamradio/svxlink node/en

{{DISPLAYTITLE:Build a SvxLink node from scratch (Raspberry Pi)}}
<languages/>

''A complete, hand-held walkthrough: from a blank microSD card to a working '''SvxLink''' node on a Raspberry Pi — download the OS, flash it with Wi-Fi and SSH already set, find the Pi on your network, log in, build SvxLink, drop in a config, and add a web dashboard. No prior Linux experience needed. Copy-paste friendly.''

<div style="border-left:4px solid #4da3ff; background:#13233a; padding:10px 16px; margin:14px 0; border-radius:6px;">💡 '''What you'll end up with:''' a Raspberry Pi running SvxLink, connected to a '''SVXReflector''', with Swedish and English voice prompts, that you can see and control from a browser. Allow about an hour (most of it is the Pi compiling by itself).</div>

[[File:Svxlink_node_flow.png|center|frameless|920px|alt=Eight steps: download Raspberry Pi OS, flash with Pi Imager (hostname/SSH/Wi-Fi), boot, find IP, connect over SSH/PuTTY, install SvxLink, edit svxlink.conf, start it and add the dashboard.]]

__TOC__

== What you need ==

* A '''Raspberry Pi 3, 4 or 5''' (a Pi Zero 2 W works but is slow to compile).
* A '''microSD card''', 16 GB or larger, and a card reader on your PC.
* A '''sound interface''' for the radio side (USB sound card, a hat like the WM8960, or a DRA/repeater board) — not needed just to get the software running.
* Your '''callsign''' and a '''reflector login''' (host + AUTH_KEY) for the SVXReflector you want to join.

== Part 1 — Download Raspberry Pi OS ==

Get the '''64-bit Lite''' image of '''Raspberry Pi OS 13 (Trixie)''' — "Lite" has no desktop, which is what you want for a node.

* Easiest: install '''Raspberry Pi Imager''' (it downloads the OS for you): https://www.raspberrypi.com/software/
* Imager runs on Windows, macOS and Linux.

== Part 2 — Flash the SD card (with SSH + Wi-Fi pre-set) ==

This is the step that saves you a keyboard and monitor. In '''Raspberry Pi Imager''':

# '''Choose Device:''' your Pi model.
# '''Choose OS:''' ''Raspberry Pi OS (other)'' → '''Raspberry Pi OS Lite (64-bit)'''.
# '''Choose Storage:''' your SD card.
# Click '''Next''' → '''Edit Settings''' (the gear / "would you like to apply OS customisation?"). Set:

{| class="wikitable" style="width:100%;"
|-
! Setting !! What to put
|-
| '''Hostname''' || e.g. <code>svxnode</code> — you'll reach the Pi as <code>svxnode.local</code>.
|-
| '''Enable SSH''' || Yes → "Use password authentication" (simplest).
|-
| '''Username / password''' || pick your own, e.g. user <code>pi</code>. '''Write it down.'''
|-
| '''Configure wireless LAN''' || your Wi-Fi SSID + password, and your '''Wi-Fi country''' (important or Wi-Fi stays off).
|-
| '''Locale / timezone / keyboard''' || your country.
|}

Save, then '''Write'''. When it finishes, eject the card.

<div style="border-left:4px solid #e0b33a; background:#2a2208; padding:10px 16px; margin:14px 0; border-radius:6px;">⚠ If you skip the Wi-Fi/SSH customisation, the Pi boots with no way in. Either redo this step, or plug in an Ethernet cable (SSH is still enabled only if you ticked it).</div>

== Part 3 — Boot the Pi ==

Put the card in the Pi, connect the radio/sound hardware if you have it, and power it on. The first boot takes '''a minute or two''' (it expands the filesystem and joins Wi-Fi). Give it time before looking for it.

== Part 4 — Find the Pi's IP address ==

You need the Pi's IP (or its <code>.local</code> name) to log in. Pick whichever works:

* '''Hostname (easiest):''' just use <code>svxnode.local</code> (the hostname you set + <code>.local</code>). Works on most home networks.
* '''Your router:''' open your router's admin page → the '''DHCP client / connected devices''' list → find <code>svxnode</code> and note its IP (e.g. <code>192.168.1.42</code>).
* '''Scan the network''' from your PC:
<pre>ping svxnode.local
# or scan the subnet (Linux/Mac):   nmap -sn 192.168.1.0/24</pre>

== Part 5 — Connect over SSH ==

'''Windows:''' download and run '''PuTTY''' — https://www.putty.org/ . In '''Host Name''' type <code>svxnode.local</code> (or the IP), '''Port''' 22, '''Open'''. Accept the key warning the first time, then log in with the username/password you set.

'''macOS / Linux:''' just use a terminal:
<pre>ssh pi@svxnode.local</pre>

Once you're in, bring the system up to date:
<pre>sudo apt update && sudo apt full-upgrade -y</pre>

== Part 6 — Install SvxLink ==

SvxLink isn't in the Pi's default repos as a current build, so you compile it (the Pi does the work). This one script installs the build tools, fetches the source from GitHub, builds and installs it, and downloads the '''Swedish (sv_SE)''' and '''English (en_US)''' voice prompts. Paste it into the SSH session:

<pre>#!/bin/bash
set -e
cd ~
mkdir -p ./projects/svxlink
cd ./projects/svxlink

sudo apt update
sudo apt dist-upgrade -y
sudo apt autoremove -y

sudo apt install -y \
  build-essential cmake git wget \
  libgpiod3 libgpiod-dev \
  alsa-utils \
  libsigc++-2.0-dev libgsm1-dev libpopt-dev \
  tcl8.6-dev \
  libgcrypt20-dev libspeex-dev libasound2-dev libopus-dev librtlsdr-dev \
  doxygen groff vorbis-tools curl \
  qtbase5-dev qttools5-dev-tools qttools5-dev \
  libjsoncpp-dev libcurl4-gnutls-dev libogg-dev \
  sox

# system user for svxlink (ignored if it already exists)
if ! id -u svxlink >/dev/null 2>&1; then
  sudo useradd -r -G audio,plugdev,dialout svxlink
fi

# fetch the source
if [ ! -d svxlink ]; then
  git clone https://github.com/sm0svx/svxlink.git
fi

mkdir -p svxlink/src/build
cd svxlink/src/build
cmake -DCMAKE_INSTALL_PREFIX=/usr -DSYSCONF_INSTALL_DIR=/etc \
      -DLOCAL_STATE_DIR=/var -DWITH_SYSTEMD=yes ..
make -j"$(nproc)"
make doc
sudo make install
sudo ldconfig

# voice prompts: Swedish + English
cd ~/projects/svxlink
cp svxlink/src/svxlink/scripts/filter_sounds.sh ./
cp svxlink/src/svxlink/scripts/play_sound.sh   ./
[ -d svxlink-sounds-en_US-heather ] || git clone https://github.com/sm0svx/svxlink-sounds-en_US-heather.git
[ -d svxlink-sounds-sv_SE-elin ]    || git clone https://github.com/sm0svx/svxlink-sounds-sv_SE-elin.git
sudo ./filter_sounds.sh svxlink-sounds-en_US-heather en_US
sudo ./filter_sounds.sh svxlink-sounds-sv_SE-elin   sv_SE
cd /usr/share/svxlink/sounds
sudo tar xvjf ~/projects/svxlink/svxlink-sounds-en_US.tar.bz2
sudo tar xvjf ~/projects/svxlink/svxlink-sounds-sv_SE.tar.bz2</pre>

<div style="border-left:4px solid #4da3ff; background:#13233a; padding:10px 16px; margin:14px 0; border-radius:6px;">💡 <code>make -j"$(nproc)"</code> builds on all CPU cores. On a Pi 3 the compile can take 20–40 minutes — that's normal. Go get a coffee; it's working.</div>

== Part 7 — Configure svxlink.conf ==

The config lives in <code>/etc/svxlink/svxlink.conf</code>. Edit it:
<pre>sudoedit /etc/svxlink/svxlink.conf</pre>

The parts you '''must''' set are the logic sections. The most important is the reflector connection — here is a working '''<code>[ReflectorLogic]</code>''' (secrets replaced with <code>CHANGE_ME</code>):

<pre>[ReflectorLogic]
TYPE=Reflector
ID=9
HOSTS=svx.sa7aux.se          ; your reflector's hostname
CALLSIGN="MYCALL"            ; your callsign
AUTH_KEY="CHANGE_ME_long_random_secret"   ; the key your reflector expects
CERT_EMAIL=you@example.org   ; for the auto TLS certificate
DEFAULT_TG=0
MONITOR_TGS=9,240,24016,24020,24021   ; talkgroups you want to hear
UDP_HEARTBEAT_INTERVAL=5
NODE_INFO_FILE=/etc/svxlink/node_info.json
EVENT_HANDLER=/usr/share/svxlink/events.tcl</pre>

<div style="border-left:4px solid #5fd38a; background:#12211a; padding:10px 16px; margin:14px 0; border-radius:6px;">📥 '''Want the whole thing?''' Download a complete, sanitised set of example configs — <code>svxlink.conf</code>, <code>node_info.json</code>, <code>gpio.conf</code> and the module files, all secrets blanked: [https://sa7aux.se/svxlink-config-example.zip svxlink-config-example.zip]. Unzip into <code>/etc/svxlink/</code> and change the callsign, reflector host, <code>AUTH_KEY</code> and position to your own.</div>

Other sections to glance at:

{| class="wikitable" style="width:100%;"
|-
! Section !! What it's for
|-
| '''[GLOBAL]''' || Which logics load (<code>LOGICS=SimplexLogic,ReflectorLogic</code>), and the sound-prompt language — set <code>LANG=sv_SE</code> or <code>LANG=en_US</code>.
|-
| '''[SimplexLogic]''' || Your node's own callsign ID, DTMF commands, and which reflector logic it links to.
|-
| '''[Rx1] / [Tx1]''' || The audio devices and PTT/COS for your radio interface (ALSA device, squelch, CTCSS).
|-
| '''[LocationInfo]''' || Optional APRS beacon (position, frequency) — all commented out by default.
|}

<div style="border-left:4px solid #e0b33a; background:#2a2208; padding:10px 16px; margin:14px 0; border-radius:6px;">⚠ '''Never publish your real <code>AUTH_KEY</code>, passwords or e-mail.''' The example above is deliberately blanked. Put your own values in, keep the file readable only by root, and don't paste the real file into forums or chats.</div>

== Part 8 — Start it and verify ==

Enable and start the node, then watch the log:
<pre>sudo systemctl enable --now svxlink
sudo systemctl status svxlink
sudo journalctl -u svxlink -f</pre>

In the log you should see it connect to the reflector and announce in your chosen language. If someone talks on a monitored talkgroup, you'll hear it (and see it in the log). <code>Ctrl-C</code> stops following the log (the service keeps running).

<div style="border-left:4px solid #4da3ff; background:#13233a; padding:10px 16px; margin:14px 0; border-radius:6px;">💡 Setting up a '''reflector''' instead of a node? The same build also installed <code>svxreflector</code> — enable that service (<code>sudo systemctl enable --now svxreflector</code>) and configure <code>/etc/svxlink/svxreflector.conf</code>.</div>

== Add the web dashboard ==

Once the node runs, give yourself a browser page to see status and switch talkgroups — install the '''[[Hamradio/svxspot_dashboard|SvxSpot Dashboard]]''' on the same Pi. It reads this same <code>svxlink.conf</code> and controls the node for you.

== Troubleshooting ==

{| class="wikitable" style="width:100%;"
|-
! Symptom !! Check
|-
| '''Can't reach <code>svxnode.local</code>''' || Use the IP from your router instead. On some networks <code>.local</code> (mDNS) is blocked.
|-
| '''SSH "connection refused"''' || SSH wasn't enabled in Imager, or the Pi isn't booted yet — wait, or re-flash with SSH ticked.
|-
| '''No Wi-Fi''' || Wrong Wi-Fi country in Imager, or wrong SSID/password. Re-flash, or use Ethernet.
|-
| '''<code>make</code> fails''' || Usually a missing build package — re-run the <code>apt install</code> line from Part 6, then <code>make</code> again.
|-
| '''Won't connect to the reflector''' || Wrong <code>HOSTS</code>, <code>CALLSIGN</code> or <code>AUTH_KEY</code> — check with the reflector operator. Watch <code>journalctl -u svxlink -f</code>.
|-
| '''No audio / no voice prompts''' || Check <code>LANG</code> in <code>[GLOBAL]</code>, and that the sound tarballs unpacked into <code>/usr/share/svxlink/sounds</code>.
|}

== See also ==

* [[Hamradio/svxspot_dashboard|SvxSpot Dashboard]] — the browser control panel for this node.
* [[Hamradio/chan_svx|chan_svx]] / [[Hamradio/chan_svx_sat|chan_svx_sat]] — bridge an AllStarLink node to a SVXReflector instead.
* [[Hamradio]] — the rest of the digital-voice how-tos.
* Author: '''SA7AUX''' &lt;bjorne@sa7aux.se&gt;. SvxLink © SM0SVX, GNU GPL.

[[Category:Ham radio]]