Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-06-17 11:19:43 -04:00
Code Issues Projects Releases Packages Wiki Activity

Minor changes to description of qubes-builder-v2

Browse source
This commit is contained in:
unman 2025-04-13 12:57:18 +00:00
parent 81e4abc416
commit 63ad8ab1c1
No known key found for this signature in database
GPG key ID: BB52274595B71262
1 changed files with 27 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

52
developer/building/qubes-builder-v2.md
View file

@ -10,8 +10,8 @@ ref: 311
title: Qubes builder v2 title: Qubes builder v2
--- ---
This is a brief introduction of using Qubes Builder v2 to work with Qubes OS This is a brief introduction to using Qubes Builder v2 to work with Qubes OS
sources. It will walk you through installing and configuring Builder v2 and sources. It will walk you through installing and configuring Builder v2, and
using it to fetch and build Qubes OS packages. using it to fetch and build Qubes OS packages.
For details and customization, use [Qubes OS v2 builder documentation](https://github.com/QubesOS/qubes-builderv2/). For details and customization, use [Qubes OS v2 builder documentation](https://github.com/QubesOS/qubes-builderv2/).
@ -30,25 +30,17 @@ uploading stages are executed locally outside a cage.
# Setup # Setup
This is a simple setup for using a docker executor (a good default choice, This is a simple setup using a docker executor. This is a good default choice;
if you don't know which executor to use, use docker). if you don't know which executor to use, use docker.
1. First, decide what qube are you going to use for working with Qubes 1. First, decide what qube you are going to use when working with Qubes
Builder v2. It can be an AppVM or a Standalone qube, with some steps Builder v2. It can be an AppVM or a Standalone qube, with some steps
different between the two. different between the two.
2. Then, clone the qubes-builder v2 repository into a location of your 2. Installing dependencies
choice:
```shell
git clone https://github.com/QubesOS/qubes-builderv2
cd qubes-builderv2/
```
3. Installing dependencies If you want to use an app qube for developing, install dependencies in the template.
If you are using a standalone, install them in the qube itself.
Dependencies need to be installed for the qube you want to be developing
using Qubes Builder v2 - either in its template, or in the qube itself,
if it's a standalone.
Dependencies are specified in `dependencies-*. Dependencies are specified in `dependencies-*.
txt` files in the main builder directory, and you can install them easily txt` files in the main builder directory, and you can install them easily
in the following ways: in the following ways:
@ -64,7 +56,16 @@ if you don't know which executor to use, use docker).
$ test -f /usr/share/qubes/marker-vm && sudo apt install qubes-gpg-split $ test -f /usr/share/qubes/marker-vm && sudo apt install qubes-gpg-split
``` ```
4. If you haven't used docker in the current qube, you need also to set up If you have installed dependencies in the template, close it, and
(re)start the development qube.
3. Clone the qubes-builder v2 repository into a location of your choice:
```shell
git clone https://github.com/QubesOS/qubes-builderv2
cd qubes-builderv2/
```
4. If you haven't previously used docker in the current qube, you need to set up
some permissions. In particular, the user has to be added to the `docker` some permissions. In particular, the user has to be added to the `docker`
group: group:
```shell ```shell
@ -77,8 +78,8 @@ if you don't know which executor to use, use docker).
$ tools/generate-container-image.sh docker $ tools/generate-container-image.sh docker
``` ```
In an AppVM, as `/var/lib/docker` is not persistent by default, you also In an app qube, as `/var/lib/docker` is not persistent by default, you also
need to use bind-dirs to avoid repeating this step after reboot, adding need to use [bind-dirs](/doc/bind-dirs/) to avoid repeating this step after reboot, adding
the following to the `/rw/config/qubes-bind-dirs.d/docker.conf` file in the following to the `/rw/config/qubes-bind-dirs.d/docker.conf` file in
this qube: this qube:
@ -148,13 +149,14 @@ using Fedora 37, `vm-fc40` would be a qube using Fedora 40 etc.), use:
$ ./qb -c core-admin-client -d host-fc37 package fetch prep build $ ./qb -c core-admin-client -d host-fc37 package fetch prep build
``` ```
If you want to fetch entire Qubes OS sources (caution: some repositories might If you want to fetch the entire Qubes OS source use the following:
have additional requirements; you can disable repositories that are not
needed in the `example-configs/*.yml` file you are using by commenting them
out. In particular, `python-fido2`, `lvm` and `windows`-related repositories
have
special requirements), use the following:
```shell ```shell
$ ./qb package fetch $ ./qb package fetch
``` ```
**caution**: some repositories might have additional requirements. You can
disable repositories that are not needed in the `example-configs/*.yml`
file you are using by commenting them out. In particular, `python-fido2`,
`lvm` and `windows`-related repositories have special requirements.