sourcezap/README.md
2024-07-16 18:13:59 -03:00

2.6 KiB

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

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>

Requirements

Sources

License

BSD Zero Clause
See LICENSE