sourcezap/README.md
2024-05-11 20:26:54 -03:00

2.1 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
# 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

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

# Start over: erase /usr/src/ and /home/_sourcezap/src/
# This command requires root privileges
$ sourcezap erase

ENVIRONMENT

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

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

  • $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

License

BSD Zero Clause.
See LICENSE.