portzap/README.md
0x1eef 382581136e
Some checks are pending
portzap / shellcheck (push) Waiting to run
Add setup/setup-user
2024-07-26 11:34:07 -03:00

2.6 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.

Examples

CLI: setup-portzap

setup-portzap should be run after installing portzap for the first time.
There is no harm in running setup-portzap multiple times:

# Add the '_portzap' user, group and home directory
# This command requires root privileges
root@localhost# setup-portzap

CLI: portzap

# Clone the HardenedBSD ports tree into /home/_portzap/ports/
# This command is delegated to the '_portzap' user
user@localhost$ portzap clone

# Pull updates into /home/_portzap/ports/
# This command is delegated to the '_portzap' user
user@localhost$ portzap pull

# Checkout a branch other than the default: hardenedbsd/main
# This command is delegated to the '_portzap' user
user@localhost$ portzap checkout freebsd/main

# Install /home/_portzap/ports/ into /usr/ports/
# This command requires root privileges
root@localhost# portzap install

# Remove the contents of /usr/ports/ and /home/_portzap/ports/
# This command requires root privileges
root@localhost# portzap rm

Environment

Install

Package

portzap is available from the HardenedBSD ports tree.
pkg install portzap should work too but expect slower updates.

Git

The most recent version of portzap can be installed via git:

# Clone
user@localhost$ git clone https://git.hardenedbsd.org/0x1eef/portzap.git
user@localhost$ cd portzap

# Install
root@localhost# make install
root@localhost# setup-portzap

# Add user to '_portzap' group
root@localhost# pw groupmod -n _portzap -m <user>

Requirements

Sources

License

BSD Zero Clause
See LICENSE