spinifex/docs/install-source

title, description, category, tags, resources

title	description	category	tags	resources
Source Install	Build Spinifex from source for development, custom builds, or contributing.	Getting Started	install source development	title url Spinifex Repository https://github.com/mulgadc/spinifex title url Go Downloads https://go.dev/dl/

Source Installation

Build Spinifex from source for development, custom builds, or contributing.

Table of Contents

• Overview
• Instructions
• Troubleshooting

---

Overview

This guide builds Spinifex from source. For production deployments, the binary installer is recommended.

Requirements:

• Ubuntu 22.04+ / Debian 12+
• Go 1.26.2+
• GCC, make, pkg-config
• QEMU/KVM, OVN/Open vSwitch, AWS CLI v2, dhcpcd-base

Instructions

Step 1. Install Dependencies

mkdir -p ~/Development/mulga && cd ~/Development/mulga
git clone https://github.com/mulgadc/spinifex.git
sudo make -C spinifex quickinstall
export PATH=$PATH:/usr/local/go/bin

Step 2. Clone and Build

cd spinifex
./scripts/clone-deps.sh
./scripts/dev-setup.sh

Confirm ./bin/spx exists.

Step 3. Setup OVN

If your WAN interface is already a bridge (e.g. br-wan), setup-ovn.sh auto-detects it:

./scripts/setup-ovn.sh --management

If your WAN is a physical NIC, choose one:

# Dedicated WAN NIC (not your SSH connection):
./scripts/setup-ovn.sh --management --wan-bridge=br-wan --wan-iface=eth1

# Single-NIC host (SSH-safe macvlan):
./scripts/setup-ovn.sh --management --macvlan --wan-iface=enp0s3

Step 4. Initialize

sudo ./bin/spx admin init --node node1 --nodes 1

Save the admin credentials printed during init.

Step 5. Start Services

./scripts/start-dev.sh

Step 6. Verify

export AWS_PROFILE=spinifex
aws ec2 describe-instance-types

If this returns a list of available instance types, your installation is working.

Congratulations! Spinifex is installed from source.

Continue to Setting Up Your Cluster to import an AMI, create a VPC, and launch your first instance.

Troubleshooting

Go Not Found in PATH

export PATH=$PATH:/usr/local/go/bin

./bin/spx Missing After Build

./scripts/dev-setup.sh

CA Certificate Not Trusted

sudo cp ~/spinifex/config/ca.pem /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates