92 lines
2.7 KiB
Markdown
92 lines
2.7 KiB
Markdown
## About
|
|
|
|
sourcezap manages a local copy of the
|
|
[HardenedBSD source tree](https://git.HardenedBSD.org/HardenedBSD/HardenedBSD).
|
|
The copy of the source tree is maintained by members of
|
|
the `_sourcezap` group, and a copy of the source tree
|
|
can be installed into `/usr/src/` by root.
|
|
|
|
## Examples
|
|
|
|
#### CLI: setup-sourcezap
|
|
|
|
`setup-sourcezap` should be run after installing
|
|
sourcezap for the first time. <br> There is no harm in
|
|
running `setup-sourcezap` multiple times:
|
|
|
|
# Add the '_sourcezap' user, group and home directory
|
|
# This command requires root privileges
|
|
root@localhost# setup-sourcezap
|
|
|
|
#### CLI: sourcezap
|
|
|
|
# Clone the HardenedBSD source tree into /home/_sourcezap/src/
|
|
# This command is delegated to the '_sourcezap' user
|
|
user@localhost$ sourcezap clone
|
|
|
|
# Pull updates into /home/_sourcezap/src/
|
|
# This command is delegated to the '_sourcezap' user
|
|
user@localhost$ sourcezap pull
|
|
|
|
# Checkout a branch other than the default: hardened/14-stable/master
|
|
# This command is delegated to the '_sourcezap' user
|
|
user@localhost$ sourcezap checkout hardened/13-stable/master
|
|
|
|
# Install /home/_sourcezap/src/ into /usr/src/
|
|
# This command requires root privileges
|
|
root@localhost# sourcezap install
|
|
|
|
# Remove the contents of /usr/src/ and /home/_sourcezap/src/
|
|
# This command requires root privileges
|
|
root@localhost# sourcezap rm
|
|
|
|
|
|
#### Environment
|
|
|
|
* __$SOURCEZAP\_CLONEURL__ <br>
|
|
The URL of a git repository <br>
|
|
Default: https://git.HardenedBSD.org/HardenedBSD/HardenedBSD.git
|
|
|
|
* __$SOURCEZAP\_INSTALLDIR__ <br>
|
|
The directory where the source tree will be installed <br>
|
|
Default: /usr/src/
|
|
|
|
## Install
|
|
|
|
#### Package
|
|
|
|
sourcezap is available
|
|
[from the HardenedBSD ports tree](https://git.HardenedBSD.org/HardenedBSD/ports/-/tree/HardenedBSD/main/hardenedbsd/sourcezap). <br>
|
|
`pkg install sourcezap` should work too but expect slower updates.
|
|
|
|
#### Git
|
|
|
|
The most recent version of sourcezap can be installed via git:
|
|
|
|
# Clone
|
|
user@localhost$ git clone https://git.hardenedbsd.org/0x1eef/sourcezap.git
|
|
user@localhost$ cd sourcezap
|
|
|
|
# Install
|
|
root@localhost# make install
|
|
root@localhost# setup-sourcezap
|
|
|
|
# Add user to '_sourcezap' group
|
|
root@localhost# pw groupmod -n _sourcezap -m <user>
|
|
|
|
## Requirements
|
|
|
|
* [doas](https://man.openbsd.org/doas)
|
|
* [git](https://www.man7.org/linux/man-pages/man1/git.1.html)
|
|
|
|
## Sources
|
|
|
|
* [GitHub](https://github.com/0x1eef/sourcezap)
|
|
* [GitLab](https://gitlab.com/0x1eef/sourcezap)
|
|
* [git.HardenedBSD.org/@0x1eef](https://git.HardenedBSD.org/0x1eef/sourcezap)
|
|
* [brew.bsd.cafe/@0x1eef](https://brew.bsd.cafe/0x1eef/sourcezap)
|
|
|
|
## License
|
|
|
|
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/) <br>
|
|
See [LICENSE](./LICENSE)
|