README: update
This commit is contained in:
parent
136c137e99
commit
f937372f9a
1 changed files with 27 additions and 37 deletions
64
README.md
64
README.md
|
@ -1,60 +1,50 @@
|
|||
## About
|
||||
|
||||
portzap is designed to allow unprivileged users who are members
|
||||
of the `_portzap` group to create and update a transient copy of
|
||||
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
|
||||
update.
|
||||
portzap is a utility that manages a local copy of the
|
||||
[hardenedbsd ports tree](https://git.hardenedbsd.org/hardenedbsd/ports),
|
||||
|
||||
## Usage
|
||||
## Examples
|
||||
|
||||
**Commands**
|
||||
**CLI**
|
||||
|
||||
* __portzap clone__ <br>
|
||||
Clones the ports tree into `/home/_portzap/ports/`.
|
||||
# Clones the ports tree into "/home/_portzap/ports/"
|
||||
$ portzap clone
|
||||
|
||||
* __portzap pull__ <br>
|
||||
Pulls updates into `/home/_portzap/ports/`.
|
||||
# Pulls updates into "/home/_portzap/ports/"
|
||||
$ portzap pull
|
||||
|
||||
* __portzap install__ <br>
|
||||
Installs `/home/_portzap/ports/` into `/usr/ports/`. <br>
|
||||
# Installs "/home/_portzap/ports/" into "/usr/ports/"
|
||||
# portzap install
|
||||
|
||||
**Environment variables**
|
||||
**Environment**
|
||||
|
||||
* __$PORTZAP_PORTS_URL__
|
||||
The URL of a git repository. <br>
|
||||
Defaults to https://git.hardenedbsd.org/hardenedbsd/ports.git.
|
||||
# The URL of a git repository
|
||||
# Defaults to https://git.hardenedbsd.org/hardenedbsd/ports.git
|
||||
export PORTZAP_PORTS_URL=https://github.com/HardenedBSD/ports
|
||||
|
||||
# The directory where the ports collection will be installed
|
||||
# Defaults to "/usr/ports/"
|
||||
export PORTZAP_PORTS_DIR=/path/to/ports
|
||||
|
||||
## Install
|
||||
|
||||
portzap can be installed through git, or via a port. <br>
|
||||
The port makes installation, and deinstallation easier.
|
||||
|
||||
__Port__ <br>
|
||||
|
||||
See [0x1eef/ports/freebsd/hardenedbsd/portzap](https://git.hardenedbsd.org/0x1eef/ports/-/tree/main/freebsd/hardenedbsd/portzap).
|
||||
|
||||
__Git__ <br>
|
||||
|
||||
```
|
||||
git clone https://git.hardenedbsd.org/0x1eef/portzap.git
|
||||
cd portzap
|
||||
cp -R bin /usr/local/
|
||||
cp -R libexec /usr/local/
|
||||
pw useradd -n _portzap \
|
||||
$ git clone https://github.com/0x1eef/portzap.git
|
||||
$ cd portzap
|
||||
# cp -R bin /usr/local/
|
||||
# cp -R libexec /usr/local/
|
||||
# pw useradd -n _portzap \
|
||||
-c "portzap utility user" \
|
||||
-m \
|
||||
-s /sbin/nologin
|
||||
pw groupmod -n _portzap -m <user>
|
||||
# pw groupmod -n _portzap -m <user>
|
||||
```
|
||||
|
||||
## Sources
|
||||
|
||||
* [Source code (git.hardenedbsd.org)](https://git.hardenedbsd.org/0x1eef/portzap)
|
||||
* [Source code (GitHub)](https://github.com/0x1eef/portzap)
|
||||
* [Source code (GitLab)](https://gitlab.com/0x1eef/portzap)
|
||||
* [GitHub](https://github.com/0x1eef/portzap)
|
||||
* [GitLab](https://gitlab.com/0x1eef/portzap)
|
||||
* [git.hardenedbsd.org](https://git.hardenedbsd.org/0x1eef/portzap)
|
||||
|
||||
## License
|
||||
|
||||
|
|
Loading…
Reference in a new issue