mirror of
https://github.com/mulgadc/spinifex.git
synced 2026-10-19 10:52:04 +00:00
Josh Siviour
e84753f9b9
* 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.
103 lines
2.4 KiB
Markdown
103 lines
2.4 KiB
Markdown
---
|
|
title: "Source Install"
|
|
seoTitle: "Build and Install Spinifex from Source — Spinifex Docs"
|
|
description: "Build Spinifex from source on Ubuntu or Debian for development, custom builds, or contributing changes, then install and run the resulting binaries locally."
|
|
category: "Install"
|
|
tags:
|
|
- install
|
|
- source
|
|
- development
|
|
resources:
|
|
- title: "Spinifex Repository"
|
|
url: "https://github.com/mulgadc/spinifex"
|
|
- title: "Go Downloads"
|
|
url: "https://go.dev/dl/"
|
|
---
|
|
|
|
# Source Installation
|
|
|
|
> Build Spinifex from source for development, custom builds, or contributing.
|
|
|
|
## Table of Contents
|
|
|
|
- [Overview](#overview)
|
|
- [Instructions](#instructions)
|
|
- [Troubleshooting](#troubleshooting)
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
This guide builds Spinifex from source. For production deployments, the [binary installer](/docs/install) is recommended.
|
|
|
|
**Supported Operating Systems:**
|
|
|
|
- Ubuntu 26.04
|
|
- Debian 13
|
|
|
|
## Instructions
|
|
|
|
## Step 1. Install Dependencies
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
cd spinifex
|
|
./scripts/clone-deps.sh
|
|
```
|
|
|
|
This clones Predastore (S3) and Viperblock (EBS) alongside Spinifex.
|
|
|
|
## Step 3. Development Initialisation
|
|
|
|
```bash
|
|
./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
|
|
|
|
```bash
|
|
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](/docs/setting-up-your-cluster) to import an AMI, create a VPC, and launch your first instance.
|
|
|
|
## Troubleshooting
|
|
|
|
### Go Not Found in PATH
|
|
|
|
```bash
|
|
export PATH=$PATH:/usr/local/go/bin
|
|
```
|
|
|
|
### CA Certificate Not Trusted
|
|
|
|
On a node or any host running `spx`/`aws` against the cluster:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
sudo curl -fsS http://169.254.169.254/spinifex/ca.pem \
|
|
-o /usr/local/share/ca-certificates/spinifex-ca.crt
|
|
sudo update-ca-certificates
|
|
```
|