portzap/README.md

86 lines
2.3 KiB
Markdown
Raw Normal View History

2023-03-12 02:10:30 +01:00
## About
2023-01-14 18:30:29 +01:00
2023-06-10 02:25:23 +02:00
portzap is a utility that manages a local copy of the
2024-05-11 22:45:59 +02:00
[HardenedBSD ports tree](https://git.HardenedBSD.org/HardenedBSD/ports).
2024-04-19 02:31:54 +02:00
The copy of the ports tree is maintained by members of
the `_portzap` group, and the copy of the ports tree
2024-05-22 02:28:35 +02:00
can be installed into `/usr/ports/` by root.
2024-04-18 22:06:58 +02:00
2023-06-10 02:25:23 +02:00
## Examples
2023-01-16 02:36:35 +01:00
### CLI: setup-portzap
This command should be run after installing portzap for
2024-05-11 22:45:59 +02:00
the first time:
2024-05-22 03:29:30 +02:00
# Add the '_portzap' user, group and home directory
# This command requires root privileges
# setup-portzap
### CLI: portzap
2024-05-22 02:32:55 +02:00
# Clone the HardenedBSD ports tree into /home/_portzap/ports/
# This command is delegated to the '_portzap' user
2023-06-10 02:25:23 +02:00
$ portzap clone
2023-01-14 18:30:29 +01:00
2024-05-22 02:32:55 +02:00
# Pull updates into /home/_portzap/ports/
# This command is delegated to the '_portzap' user
2023-06-10 02:25:23 +02:00
$ portzap pull
2023-01-14 18:30:29 +01:00
# Checkout a branch other than the default: hardenedbsd/main
# This command is delegated to the '_portzap' user
$ portzap checkout
2024-05-22 02:32:55 +02:00
# Install /home/_portzap/ports/ into /usr/ports/
# This command requires root privileges
2023-06-10 02:25:23 +02:00
# portzap install
2023-01-14 18:30:29 +01:00
2024-05-22 02:32:55 +02:00
# Remove the contents of /usr/ports/ and /home/_portzap/ports/
# This command requires root privileges
$ portzap rm
### ENVIRONMENT
2024-04-02 04:49:45 +02:00
* __$PORTZAP\_GITURL__ <br>
The URL to a git repository <br>
Default: https://git.HardenedBSD.org/HardenedBSD/ports.git
2024-04-17 21:37:16 +02:00
2024-04-02 04:49:45 +02:00
* __$PORTZAP\_INSTALLDIR__ <br>
The directory where the ports collection will be installed <br>
Default: /usr/ports/
2023-06-10 03:04:38 +02:00
2023-06-10 02:25:23 +02:00
## Install
2023-03-19 20:03:04 +01:00
2024-04-17 19:22:46 +02:00
**Port**
portzap is available
2024-05-11 22:45:59 +02:00
[as a HardenedBSD port](https://git.HardenedBSD.org/HardenedBSD/ports/-/tree/HardenedBSD/main/hardenedbsd/portzap). <br>
2024-04-17 19:22:46 +02:00
`pkg install portzap` should work too but expect slower updates.
**Source**
The most recent version of portzap can be installed directly
via git:
$ git clone https://github.com/0x1eef/portzap.git
$ cd portzap
# make install
2024-05-23 03:09:33 +02:00
# setup-portzap
# pw groupmod -n _portzap -m <user>
2023-03-19 20:03:04 +01:00
## Requirements
2024-04-17 19:22:46 +02:00
* [doas](https://man.openbsd.org/doas) (`pkg install doas`)
* [git](https://www.man7.org/linux/man-pages/man1/git.1.html) (`pkg install git`)
2023-03-12 02:10:30 +01:00
## Sources
2023-01-14 18:45:46 +01:00
2023-06-10 02:25:23 +02:00
* [GitHub](https://github.com/0x1eef/portzap)
* [GitLab](https://gitlab.com/0x1eef/portzap)
2024-05-11 22:45:59 +02:00
* [git.HardenedBSD.org](https://git.HardenedBSD.org/0x1eef/portzap)
2023-03-12 02:15:32 +01:00
## License
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/) <br>
See [LICENSE](./LICENSE)