Files
spinifex/docs/install/install-source/README.md
T
Josh Siviour e84753f9b9 docs: bring doc titles and descriptions into SEO length limits (#831)
* docs: bring doc titles and descriptions into SEO length limits

Rewrite the frontmatter title and description of every published doc so the
rendered <title> lands in 50-60 characters (including the site suffix) and the
meta description lands in 150-160 characters.

* docs: move SEO titles to a seoTitle field and restore display titles

The frontmatter title renders as the page H1 and the sidebar label, so tuning it
for the title tag shortened nothing and lengthened the visible navigation. Put
the search-facing string in seoTitle and give title back its original value.
2026-08-19 12:05:59 +10:00

2.4 KiB

title, seoTitle, description, category, tags, resources
title seoTitle description category tags resources
Source Install Build and Install Spinifex from Source — Spinifex Docs Build Spinifex from source on Ubuntu or Debian for development, custom builds, or contributing changes, then install and run the resulting binaries locally. Install
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

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

Supported Operating Systems:

  • Ubuntu 26.04
  • Debian 13

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 Sibling Repositories

cd spinifex
./scripts/clone-deps.sh

This clones Predastore (S3) and Viperblock (EBS) alongside Spinifex.

Step 3. Development Initialisation

./scripts/dev-install.sh

This bootstraps a single-node development environment: builds binaries, configures OVN, initialises the cluster, installs the CA certificate, and starts all services.

Step 4. Verify Installation

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

CA Certificate Not Trusted

On a node or any host running spx/aws against the cluster:

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

Inside a guest VM there is no /etc/spinifex; fetch the CA from IMDS instead:

sudo curl -fsS http://169.254.169.254/spinifex/ca.pem \
  -o /usr/local/share/ca-certificates/spinifex-ca.crt
sudo update-ca-certificates