sourcezap/README.md

About

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

Examples

CLI: setup-srczap

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

# Add the srczap user, group and home directory.
# This command requires root privileges.
# setup-srczap

CLI: srczap

# Clone the HardenedBSD source tree into /home/_srczap/src/.
# This command is delegated to the '_srczap' user.
$ srczap clone

# Pull updates into /home/_srczap/src/.
# This command is delegated to the '_srczap' user.
$ srczap pull

# Install /home/_srczap/src/ into /usr/src/.
# This command requires root privileges.
# srczap install

# Start over: erase /usr/src/ and /home/_srczap/src/.
# This command requires root privileges.
$ srczap erase

ENVIRONMENT

• $SRCZAP_GITURL
  The URL to a git repository.
  Default: https://git.HardenedBSD.org/HardenedBSD/HardenedBSD.git.

• $SRCZAP_BRANCH
  The git branch to clone and pull updates from.
  Default: hardened/14-stable/master.

• $SRCZAP_INSTALLDIR
  The directory where the source tree will be installed.
  Default: /usr/src/.

Install

Source

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

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

Requirements

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

Sources

• GitHub
• GitLab
• git.HardenedBSD.org

License

BSD Zero Clause.
See LICENSE.