portzap/README.md
0x1eef 9e5f98f73e
Some checks failed
portzap / shellcheck (push) Has been cancelled
docs: update
2024-11-16 01:16:38 -03:00

2.1 KiB

About

portzap is a utility that manages a local copy of the HardenedBSD ports tree. The copy of the ports tree is maintained by members of the _portzap group, and the copy of the ports tree can be installed into /usr/ports/ by root.

CLI

Commands

Group

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

  • portzap clone
    Clone the HardenedBSD ports tree into /home/_portzap/ports/

  • portzap pull
    Pull updates into /home/_portzap/ports/

  • portzap checkout
    Checkout a branch other than the default: hardenedbsd/main

  • portzap sh
    Run /bin/sh within /home/_portzap/ports/

Root

The following commands are restricted to root:

  • portzap rm
    Remove the contents of /usr/ports/ and /home/_portzap/ports/

  • portzap install
    Install /home/_portzap/ports/ into /usr/ports/

Environment

  • $PORTZAP_CLONEURL
    The URL of a git repository
    Default: https://github.com/HardenedBSD/ports

  • $PORTZAP_INSTALLDIR
    The directory where the ports collection will be installed
    Default: /usr/ports/

Install

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

root@localhost# portzap setup
root@localhost# pw groupmod -n _portzap -m myuser

Requirements

Sources

License

BSD Zero Clause
See LICENSE