portzap/README.md

55 lines
1.6 KiB
Markdown
Raw Normal View History

2023-03-12 02:10:30 +01:00
## About
2023-01-14 18:30:29 +01:00
2023-03-12 02:07:13 +01:00
portzap is a utility for staying up to date with the
2023-03-25 08:26:44 +01:00
HardenedBSD ports tree. It is designed to make it easy
2023-03-22 17:04:32 +01:00
for unprivileged users who are members of the `_portzap`
group to create and update a transient copy of the ports
tree, which can then be installed into the `/usr/ports/`
2023-03-25 08:25:51 +01:00
directory by root. Once the initial installation is done,
future updates are incremental, which means that
2023-03-25 06:56:15 +01:00
portzap will only add, remove or update ports that have
changed since the last update.
2023-01-14 18:30:29 +01:00
2023-03-12 02:10:30 +01:00
## Usage
2023-01-16 02:36:35 +01:00
2023-03-25 06:57:57 +01:00
* __portzap clone__ <br>
2023-03-25 06:56:15 +01:00
Clones the ports tree into `/home/_portzap/ports/`.
2023-01-14 18:30:29 +01:00
2023-03-25 06:57:57 +01:00
* __portzap pull__ <br>
2023-03-22 17:04:32 +01:00
Pulls updates into `/home/_portzap/ports/`.
2023-01-14 18:30:29 +01:00
2023-03-25 06:57:57 +01:00
* __portzap install__ <br>
2023-03-22 17:04:32 +01:00
Installs `/home/_portzap/ports/` into `/usr/ports/`. <br>
2023-01-14 18:30:29 +01:00
2023-03-19 20:03:04 +01:00
## Install
2023-03-25 09:33:42 +01:00
portzap can be installed through git, or via a port. The port makes
installation, and deinstallation easier.
Port: [0x1eef/ports/freebsd/hardenedbsd/portzap](https://git.hardenedbsd.org/0x1eef/ports/-/tree/main/freebsd/hardenedbsd/portzap) )
Git :
2023-03-19 20:03:04 +01:00
```
git clone https://git.hardenedbsd.org/0x1eef/portzap.git
cd portzap
cp -R bin /usr/local/
cp -R libexec /usr/local/
2023-03-25 09:33:42 +01:00
pw useradd -n _portzap \
-c "portzap utility user" \
-m \
-s /sbin/nologin
pw groupmod -g _portzap -m <user>_
2023-03-19 20:03:04 +01:00
```
2023-03-12 02:10:30 +01:00
## Sources
2023-01-14 18:45:46 +01:00
2023-01-29 11:48:09 +01:00
* [Source code (git.hardenedbsd.org)](https://git.hardenedbsd.org/0x1eef/portzap)
2023-01-14 18:45:46 +01:00
* [Source code (GitHub)](https://github.com/0x1eef/portzap)
* [Source code (GitLab)](https://gitlab.com/0x1eef/portzap)
2023-03-12 02:15:32 +01:00
## License
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/). <br>
See [LICENSE](./LICENSE).