sourcezap/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
# setup-sourcezap

CLI: sourcezap

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

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

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

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

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

ENVIRONMENT

• $SOURCEZAP_CLONEURL
  The URL to 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

Source

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

$ git clone https://github.com/0x1eef/sourcezap.git
$ cd sourcezap
# make install
# setup-sourcezap
# pw groupmod -n _sourcezap -m <user>

Requirements

• doas (pkg install doas)
• git (pkg install git)

Sources

• GitHub
• GitLab
• git.HardenedBSD.org

License

BSD Zero Clause.
See LICENSE.