sourcezap/README.md

81 lines
2 KiB
Markdown
Raw Normal View History

2024-05-11 21:27:22 +02:00
## About
srczap manages a local copy of the
2024-05-11 22:49:13 +02:00
[HardenedBSD source tree](https://git.HardenedBSD.org/HardenedBSD/HardenedBSD).
2024-05-11 21:27:22 +02:00
The copy of the source tree is maintained by members of
the `_srczap` group, and a copy of the source tree
2024-05-11 21:43:59 +02:00
can be installed into `/usr/src/` by root.
2024-05-11 21:27:22 +02:00
## Examples
### CLI: setup-srczap
This command should be run after installing srczap for
2024-05-11 22:50:02 +02:00
the first time:
2024-05-11 21:27:22 +02:00
2024-05-12 00:40:06 +02:00
# Add the srczap user, group and home directory
# This command requires root privileges
2024-05-11 21:27:22 +02:00
# setup-srczap
### CLI: srczap
2024-05-12 00:40:06 +02:00
# Clone the HardenedBSD source tree into /home/_srczap/src/
# This command is delegated to the '_srczap' user
2024-05-11 21:27:22 +02:00
$ srczap clone
2024-05-12 00:40:06 +02:00
# Pull updates into /home/_srczap/src/
# This command is delegated to the '_srczap' user
2024-05-11 21:27:22 +02:00
$ srczap pull
2024-05-12 00:40:06 +02:00
# Install /home/_srczap/src/ into /usr/src/
# This command requires root privileges
2024-05-11 21:27:22 +02:00
# srczap install
2024-05-12 00:40:06 +02:00
# Start over: erase /usr/src/ and /home/_srczap/src/
# This command requires root privileges
2024-05-11 21:27:22 +02:00
$ srczap erase
### ENVIRONMENT
* __$SRCZAP\_GITURL__ <br>
The URL to a git repository. <br>
2024-05-11 22:49:13 +02:00
Default: https://git.HardenedBSD.org/HardenedBSD/HardenedBSD.git.
2024-05-11 21:27:22 +02:00
* __$SRCZAP\_BRANCH__ <br>
The git branch to clone and pull updates from. <br>
Default: hardened/14-stable/master.
* __$SRCZAP\_INSTALLDIR__ <br>
The directory where the source tree will be installed. <br>
Default: /usr/src/.
## Install
**Source**
The most recent version of srczap can be installed directly
via git:
$ git clone https://github.com/0x1eef/srczap.git
$ cd srczap
# make install
2024-05-11 21:56:46 +02:00
# setup-srczap
2024-05-11 21:27:22 +02:00
# pw groupmod -n _srczap -m <user>
## Requirements
* [doas](https://man.openbsd.org/doas) (`pkg install doas`)
* [git](https://www.man7.org/linux/man-pages/man1/git.1.html) (`pkg install git`)
## Sources
* [GitHub](https://github.com/0x1eef/srczap)
* [GitLab](https://gitlab.com/0x1eef/srczap)
2024-05-11 22:49:13 +02:00
* [git.HardenedBSD.org](https://git.HardenedBSD.org/0x1eef/srczap)
2024-05-11 21:27:22 +02:00
## License
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/). <br>
See [LICENSE](./LICENSE).