• Stars
    star
    318
  • Rank 131,118 (Top 3 %)
  • Language
    Python
  • License
    GNU General Publi...
  • Created over 4 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

TrueNAS SCALE Build System

Join Discord Join Forums File Issue

truenas-build

A build framework for TrueNAS SCALE.

Found an issue in the build for SCALE? Please report it on our Jira bugtracker.

Requirements

  • Debian 10 or later (VM or Bare-Metal)
  • 16GB of RAM
  • At least 15GB of free disk space

In addition to the host, you will want to pre-install the following packages:

  • build-essential
  • debootstrap
  • libjson-perl
  • git
  • python3-pip
  • python3-venv
  • squashfs-tools
  • rsync
  • unzip

% sudo apt install build-essential debootstrap git python3-pip python3-venv squashfs-tools unzip libjson-perl rsync

Usage

After the pre-requistes are installed, simply run "make" (as root or sudo) to perform a complete build which performs the following steps:

make checkout

Pulls in the latest target source repos from online. Re-run to update to latest sources at any time.

make packages

Builds all the *.deb packages from the checked out source repos and stages them for further stages. Re-running it will perform an incremental build, only re-building packages which have changed sources in source/.

make update

Builds the stand-alone update file, used for online/offline updating or building ISO images.

make iso

Builds the ISO image for fresh installation.

make clean

Cleans up all the temporary files and returns to original state.

Overrides

It is possible using make and environment variables to override which source repos get checked out during "make checkout" phase.

TRUENAS_BRANCH_OVERRIDE - Can be used to override all source repos at once

_OVERRIDE - Can override specific repos, I.E. debootstrap_OVERRIDE="master"

More Repositories

1

middleware

TrueNAS CORE/Enterprise/SCALE Middleware Git Repository
Python
2,237
star
2

webui

TrueNAS Angular UI
TypeScript
349
star
3

charts

TrueNAS SCALE Apps Catalogs & Charts
Smarty
286
star
4

core-build

TrueNAS CORE/Enterprise Build System
Python
223
star
5

os

FreeBSD base for TrueNAS Core
C
213
star
6

documentation

TrueNAS Documentation Hub
HTML
117
star
7

py-libzfs

Python libzfs bindings
Cython
78
star
8

py-SMART

Wrapper for smartctl (smartmontools)
Python
74
star
9

zettarepl

Zettabyte File System (ZFS) Replication Tool written in Python
Python
64
star
10

truenas-installer

Repo with scripts for TrueNAS installation on Debian
Python
44
star
11

ports

FreeBSD ports tree
Makefile
29
star
12

linux

Linux kernel for TrueNAS SCALE
C
25
star
13

midcli

NAS Command Line Interface
Python
16
star
14

mDNSResponder

C
15
star
15

py-sysctl

Python wrapper for the sysctl system functions
C
13
star
16

samba

C
12
star
17

nfs4xdr-acl-tools

CLI tool to manage Samba-style xdr-formatted NFSv41 ACLs
C
9
star
18

py-bsd

Python wrappers for various BSD libc and system calls
Cython
8
star
19

freenas-java-api-client

FreeNAS Java API Client: It is a java client library that allows to interact with FreeNAS by Java programatically calls
Java
8
star
20

py-netif

Python network configuration library for FreeBSD
Cython
7
star
21

apps

Python
6
star
22

chelsiouwire

C
5
star
23

licenselib

License library for FreeNAS
Python
4
star
24

truecommand-stats

Small utility that TrueCommand uses for gathering system statistics
Go
4
star
25

repo-mgmt

Scripts and tools for Apt repository management
Python
4
star
26

python-truenas-requirements

Python
3
star
27

freenas-pkgtools

FreeNAS Packaging/update/installation tools
Python
3
star
28

iocage-ix-plugins

Official iXSystems iocage plugins for TrueNAS
3
star
29

grub2

Shell
2
star
30

binaries

C
2
star
31

catalog_validation

Validate truenas compliant catalog structure / format.
Python
2
star
32

truenas-cd

Clone of debian-cd with TrueNAS build changes
Shell
2
star
33

nss-pam-ldapd

C
2
star
34

containers

Shell
1
star
35

pyglfs

C
1
star
36

firmware

Repository for firmwares
Python
1
star
37

intel-pcm

Shell
1
star
38

py-sg3

Cython
1
star
39

ixdiagnose

Python
1
star
40

smartmontools

Shell
1
star
41

minio

Python
1
star
42

pkg-qemu

https://salsa.debian.org/qemu-team/qemu
C
1
star
43

ScaleAutomation

Python
1
star
44

py-sgio

Python bindings for SG_IO ioctl on linux
Cython
1
star
45

rrdtool

Shell
1
star
46

py-fenced

Fencing daemon for automatically managing persistent SCSI reservations
Python
1
star