portzap/README.md

63 lines
1.7 KiB
Markdown
Raw Normal View History

2023-03-12 02:10:30 +01:00
## About
2023-01-14 18:30:29 +01:00
2023-05-23 00:58:01 +02:00
portzap is designed to allow unprivileged users who are members
of the `_portzap` group to create and update a transient copy of
2023-05-23 00:59:51 +02:00
the HardenedBSD ports tree, which can then be installed into the
`/usr/ports/` directory by root. Once the initial installation
is complete, future updates are incremental, which means that portzap
will only add, remove or update ports that have changed since the last
2023-05-23 00:58:01 +02:00
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
**Commands**
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
**Environment variables**
* __$PORTZAP_PORTS_URL__
The URL of a git repository. <br>
Defaults to https://git.hardenedbsd.org/hardenedbsd/ports.git.
2023-03-19 20:03:04 +01:00
## Install
2023-03-25 09:36:15 +01:00
portzap can be installed through git, or via a port. <br>
The port makes installation, and deinstallation easier.
2023-03-25 09:33:42 +01:00
2023-05-22 07:28:22 +02:00
__Port__ <br>
2023-03-25 09:39:45 +01:00
2023-03-25 09:40:17 +01:00
See [0x1eef/ports/freebsd/hardenedbsd/portzap](https://git.hardenedbsd.org/0x1eef/ports/-/tree/main/freebsd/hardenedbsd/portzap).
2023-03-25 09:39:45 +01:00
2023-03-25 09:40:17 +01:00
__Git__ <br>
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
2023-03-25 09:48:27 +01:00
pw groupmod -n _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).