0x1eef/portzap: Manages a local copy of the HardenedBSD ports tree

Manages a local copy of the HardenedBSD ports tree

Find a file

0x1eef 7ffb0d7880 Some checks are pending portzap / shellcheck (push) Waiting to run Details Update docs (README.md)		2024-08-07 02:35:26 -03:00
.github/workflows	Add shellcheck target	2024-04-02 13:40:16 -03:00
bin	Add 'portzap sh'	2024-08-07 02:10:37 -03:00
libexec/portzap	Add 'portzap sh'	2024-08-07 02:10:37 -03:00
man/man8	Add clarity to the documentation	2024-08-07 02:15:47 -03:00
share/portzap	v1.0.0	2024-08-03 00:41:37 -03:00
.projectile	Add HardenedBSD source	2023-01-29 07:48:09 -03:00
Makefile	Fix shellcheck errors (includes a bug in setup-user)	2024-07-26 22:26:07 -03:00
README.md	Update docs (README.md)	2024-08-07 02:35:26 -03:00

README.md

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: group

The following commands are delegated to the _portzap user and restricted to members of the _portzap group. The restrictions are enforced by portzap and to a lesser extent by 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/

CLI: superuser

The following commands are restricted to root.
The restrictions are enforced by portzap:

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://git.HardenedBSD.org/HardenedBSD/ports.git
$PORTZAP_INSTALLDIR
The directory where the ports collection will be installed
Default: /usr/ports/

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>