portzap/README.md

57 lines
1.4 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
[hardenedbsd ports tree](https://git.hardenedbsd.org/hardenedbsd/ports),
2023-01-14 18:30:29 +01:00
2023-06-10 02:25:23 +02:00
## Examples
2023-01-16 02:36:35 +01:00
2023-06-10 02:25:23 +02:00
**CLI**
2023-06-10 02:25:23 +02:00
# Clones the ports tree into "/home/_portzap/ports/"
$ portzap clone
2023-01-14 18:30:29 +01:00
2023-06-10 02:25:23 +02:00
# Pulls updates into "/home/_portzap/ports/"
$ portzap pull
2023-01-14 18:30:29 +01:00
2023-06-10 02:25:23 +02:00
# Installs "/home/_portzap/ports/" into "/usr/ports/"
# portzap install
2023-01-14 18:30:29 +01:00
2023-06-10 02:25:23 +02:00
**Environment**
2023-06-10 02:25:23 +02:00
# The URL of a git repository
# Defaults to https://git.hardenedbsd.org/hardenedbsd/ports.git
export PORTZAP_PORTS_URL=https://github.com/HardenedBSD/ports
2023-06-10 02:25:23 +02:00
# The directory where the ports collection will be installed
# Defaults to "/usr/ports/"
export PORTZAP_PORTS_DIR=/path/to/ports
2023-03-25 09:39:45 +01:00
2023-06-10 03:04:38 +02:00
* __$PORTZAP_PORTS_DIR__ <br>
The directory where the ports collection will be installed. <br>
Defaults to /usr/ports.
2023-06-10 02:25:23 +02:00
## Install
2023-03-19 20:03:04 +01:00
```
2023-06-10 02:25:23 +02:00
$ git clone https://github.com/0x1eef/portzap.git
$ cd portzap
# cp -R bin /usr/local/
# cp -R libexec /usr/local/
# pw useradd -n _portzap \
2023-03-25 09:33:42 +01:00
-c "portzap utility user" \
-m \
-s /sbin/nologin
2023-06-10 02:25:23 +02: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-06-10 02:25:23 +02:00
* [GitHub](https://github.com/0x1eef/portzap)
* [GitLab](https://gitlab.com/0x1eef/portzap)
* [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).