sourcezap/README.md
0x1eef 6165f4444d
Some checks failed
sourcezap / shellcheck (push) Has been cancelled
docs: update
2024-11-16 01:19:15 -03:00

2.2 KiB

About

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

CLI

Commands

Group

The following commands are restricted to members of the _sourcezap group, and delegated to the _sourcezap user via doas(1):

  • sourcezap clone
    Clone the HardenedBSD source tree into /home/_sourcezap/src/

  • sourcezap pull
    Pull updates into /home/_sourcezap/src/

  • sourcezap checkout
    Checkout a branch other than the default: hardened/14-stable/master

  • sourcezap sh
    Run /bin/sh within /home/_sourcezap/src/

Root

The following commands are restricted to root:

  • sourcezap rm
    Remove the contents of /usr/src/ and /home/_sourcezap/src/

  • sourcezap install
    Install /home/_sourcezap/src/ into /usr/src/

Environment

Install

sourcezap is available from the HardenedBSD ports tree. pkg install sourcezap should work too but expect slower updates. After installation of sourcezap, sourcezap setup should be run as root and one or more users should be added to the _sourcezap group:

root@localhost# sourcezap setup
root@localhost# pw groupmod -n _sourcezap -m myuser

Requirements

Sources

License

BSD Zero Clause
See LICENSE