0x1eef/sourcezap: Manages a local copy of the HardenedBSD source tree

Manages a local copy of the HardenedBSD source tree

Find a file

0x1eef fb4629fda5 Replace 'git' function with '${git}' variable This change adds clarity by removing the 'git' function, which could be easily confused with the 'git' exectuable		2024-07-19 14:19:09 -03:00
.github/workflows	Update .github/	2024-05-11 20:29:04 -03:00
bin	Add functions.sh	2024-07-19 03:32:46 -03:00
libexec/sourcezap	Replace 'git' function with '${git}' variable	2024-07-19 14:19:09 -03:00
man/man8	Fix typo in man page	2024-06-22 20:21:54 -03:00
share/sourcezap	v0.1.1	2024-06-22 19:43:38 -03:00
.projectile	First commit	2024-05-11 16:03:00 -03:00
LICENSE	First commit	2024-05-11 16:03:00 -03:00
Makefile	Adopt remaining major portzap updates	2024-06-01 01:02:12 -03:00
README.md	Update docs	2024-07-16 18:13:59 -03:00

README.md

About

sourcezap manages a local copy of the HardenedBSD source tree. The copy of the source tree is maintained by members of the _sourcezap group, and a copy of the source tree can be installed into /usr/src/ by root.

Examples

CLI: setup-sourcezap

This command should be run after installing sourcezap for the first time:

# Add the '_sourcezap' user, group and home directory
# This command requires root privileges
root@localhost# setup-sourcezap

CLI: sourcezap

# Clone the HardenedBSD source tree into /home/_sourcezap/src/
# This command is delegated to the '_sourcezap' user
user@localhost$ sourcezap clone

# Pull updates into /home/_sourcezap/src/
# This command is delegated to the '_sourcezap' user
user@localhost$ sourcezap pull

# Checkout a branch other than the default: hardened/14-stable/master
# This command is delegated to the '_sourcezap' user
user@localhost$ sourcezap checkout hardened/13-stable/master

# Install /home/_sourcezap/src/ into /usr/src/
# This command requires root privileges
root@localhost# sourcezap install

# Remove the contents of /usr/src/ and /home/_sourcezap/src/
# This command requires root privileges
root@localhost# sourcezap rm

Environment

$SOURCEZAP_CLONEURL
The URL of a git repository
Default: https://git.HardenedBSD.org/HardenedBSD/HardenedBSD.git
$SOURCEZAP_INSTALLDIR
The directory where the source tree will be installed
Default: /usr/src/

Install

Package

sourcezap is available from the HardenedBSD ports tree.
pkg install sourcezap should work too but expect slower updates.

Git

The most recent version of sourcezap can be installed via git:

# Clone
user@localhost$ git clone https://git.hardenedbsd.org/0x1eef/sourcezap.git
user@localhost$ cd sourcezap

# Install
root@localhost# make install
root@localhost# setup-sourcezap

# Add user to '_sourcezap' group
root@localhost# pw groupmod -n _sourcezap -m <user>