mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2024-10-01 01:25:40 -04:00
Merge branch 'ptitdoc-patch-4'
This commit is contained in:
Andrew David Wong
commit
8a25e5f7a9
@ -8,151 +8,388 @@ redirect_from:
|
||||
- /wiki/BuildingArchlinuxTemplate/
|
||||
---
|
||||
|
||||
Template building
|
||||
=================
|
||||
# Archlinux template building instructions
|
||||
|
||||
The archlinux VM is now almost working as a NetVM. Based on qubes-builder code, you could find below how to build it and problem that could arise from template building to using archlinux as a netvm:
|
||||
**These are the instructions for Qubes 3.2. They will take you step by step through the entire process start to finish**
|
||||
|
||||
Download qubes-builder git code
|
||||
-------------------------------
|
||||
*Note: These instructions have not been tested for Qubes 3.1. However they could be working.*
|
||||
|
||||
Prefer the [marmarek git repository](https://github.com/marmarek/qubes-builder) as it is the most recent one.
|
||||
*Note: No binary package for the archlinux template exists for Qubes 3.1.*
|
||||
|
||||
~~~
|
||||
git clone https://github.com/marmarek/qubes-builder.git
|
||||
~~~
|
||||
## 1: Create and configure VM to use for template building
|
||||
|
||||
Change your builder.conf
|
||||
------------------------
|
||||
* The VM should be based on a Fedora template. It's best to use a standalone VM. I created a standalone VM based on
|
||||
the Fedora 23 template. I named the VM “**development**”. These instructions assume a standalone VM based on a Fedora template is being used.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
* Ensure there is at least 25GB preferably 30GB of free space in the private storage. I made the private storage 30GB to be safe.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
Change the following variables / add the following lines (as appropriate):
|
||||
*Note: Unless otherwise noted, all commands are from within the “development” VM or whatever you named your standalone VM used for building the template.*
|
||||
|
||||
~~~
|
||||
BUILDER_PLUGINS += builder-archlinux
|
||||
GIT_PREFIX := marmarek/qubes-
|
||||
DISTS_VM += archlinux
|
||||
~~~
|
||||
## 2: Create GitHub Account (optional)
|
||||
|
||||
If you don't already have a `builder.conf` in the root of your qubes-builder
|
||||
directory, a basic Archlinux template build may be achieved by copying
|
||||
`example-configs/debian.conf` and making the above changes (don't forget to
|
||||
also comment out any Debian-related `DISTS_VM += ` lines).
|
||||
* It can be helpful. Creating only a basic account is all that is needed. This will allow you to help, going forward, with the Qubes project. You could be help edit errors in documentation. It can also be of use building other templates.
|
||||
|
||||
Get all required sources
|
||||
------------------------
|
||||
* Create user account here https://github.com
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
~~~
|
||||
make get-sources
|
||||
~~~
|
||||
## 3: Install necessary packages to 'development' VM for "Qubes Automated Build System"
|
||||
|
||||
Note that make get-sources sometimes fails because it didn't download packages that are not used by archlinux such as xfce or kde packages.
|
||||
* Necessary packages to install:
|
||||
|
||||
You can ignore the repositories that are failing by adding the following line to your builder.conf:
|
||||
* git
|
||||
|
||||
~~~
|
||||
COMPONENTS:=$(filter-out desktop-linux-kde desktop-linux-xfce,$(COMPONENTS))
|
||||
~~~
|
||||
* createrepo
|
||||
|
||||
Just don't forget that you need to comment this line again if you want to build the whole Qubes-OS install CD.
|
||||
* rpm-build
|
||||
|
||||
Make all required Qubes components
|
||||
----------------------------------
|
||||
* make
|
||||
|
||||
The first use of the builder can take several hours depending on your bandwidth as it will install an archlinux chroot:
|
||||
* rpmdevtools
|
||||
|
||||
~~~
|
||||
make qubes-vm
|
||||
~~~
|
||||
* python-sh
|
||||
|
||||
Now build the template itself
|
||||
-----------------------------
|
||||
* dialog
|
||||
|
||||
This can take again several hours, especially the first time you built and archlinux template:
|
||||
* rpm-sign
|
||||
|
||||
~~~
|
||||
make linux-template-builder
|
||||
~~~
|
||||
* gnupg
|
||||
|
||||
Retrieve your template
|
||||
----------------------
|
||||
|
||||
You can now find your template in qubes-src/linux-template-builder/rpm/noarch. Install it in dom0 (just take care as it will replace your current archlinux-x64 template)
|
||||
* The tools can usually be installed all together with the following terminal command string:
|
||||
|
||||
* * * * *
|
||||
* **$ sudo dnf install git createrepo rpm-build make wget rpmdevtools python-sh dialog rpm-sign gnupg**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
Known problems during building or when running the VM
|
||||
=====================================================
|
||||
## 4: Installing the "Qubes Automated Build System"
|
||||
|
||||
Build fails when fetching qubes-mgmt-salt
|
||||
-----------------------------------------
|
||||
* Download the latest stable qubes-builder repository:
|
||||
|
||||
* $ **git clone https://github.com/QubesOS/qubes-builder.git**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
|
||||
* You will now have the Qubes Builder System environment installed in the directory below:
|
||||
|
||||
* **/home/user/qubes-builder/**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
## 5: Configuring setup script to create builder.conf file
|
||||
|
||||
* You will be creating the builder.conf file which tells where and what to use. The most automated, and in this case the easiest, way to create this is to use the script that is provided in Qubes Builder. Its named '**setup**'. Before running the script you need to edit one file it uses.
|
||||
|
||||
*In the future this should not be needed once a change is made to the 'setup' script.*
|
||||
|
||||
* Edit the '**qubes-os-r3.2.conf**' which is found in **/home/user/qubes-builder/example-configs** Use the text editor of your choice.
|
||||
|
||||
* **$ cd /home/user/qubes-builder/example-config/**
|
||||
|
||||
* **$ nano -W qubes-os-r3.2.conf** or **$ gedit qubes-os-r3.2.conf** or etc….
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
* Go to the first line containing '**DISTS_VM ?= fc23**' it will be preceeded by line '**DIST_DOM0 ?= fc20**'. Remove '**fc23**' or whatever is listed there leaving only '**DISTS_VM ?=**'. Then save the file and close the text editor.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
## 6: Run the 'setup' script to build the builder.conf file
|
||||
|
||||
* Run the 'setup' script located in '**/home/user/qubes-builder/**' Make sure you are in directory '**qubes-builder**'
|
||||
|
||||
* **$ cd /home/user/qubes-builder/**
|
||||
|
||||
* **$ ./setup**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
* First screen will ask you to import 'Qubes-Master-Signing-key.asc'. The 'setup' script not only downloads but confirms the key to that of the key on Qubes-OS website.
|
||||
|
||||
* Select '**YES**'
|
||||
* Select '**OK**' Press '**Enter**'
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* Next screen will ask you to import Marek Marczykowski-Goracki (Qubes OS signing key). Again 'setup' will confirm this key to the fingerprint.
|
||||
|
||||
* Select '**YES**'
|
||||
* Select '**OK**' Press '**Enter**'
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* This screen will give you the choice of which Qubes Release to build the template for.
|
||||
|
||||
* Select '**Qubes Release 3.2**'
|
||||
* Select '**OK**' Press '**Enter**'
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* Screen "**Choose Repos To Use To Build Packages**"
|
||||
|
||||
* Select 'QubesOS/qubes- Stable - Default Repo'
|
||||
* Select '**OK**' Press '**Enter**'
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* Screen "**Build Template Only?**"
|
||||
|
||||
* Select '**Yes**' Press '**Enter**'
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* Screen '**Builder Plugin Selection**' will give choices of builder plugins to use for the build.
|
||||
|
||||
* Deselect '**Fedora**'
|
||||
|
||||
* Deselect '**mgmt_salt**'
|
||||
|
||||
* Select '**builder-archlinux**'
|
||||
|
||||
* Select '**OK**' Press **Enter**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* Screen '**Get sources**' wants to download additional packages needed for the choosen plugin/s.
|
||||
|
||||
* Select '**Yes**' Press '**Enter**'
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* Then wait for download to finish and press '**OK**'
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* Screen '**Template Distribution Selection**' allows you to choose the actual template/s you wish to build.
|
||||
|
||||
* Scroll Down to the very bottom (it is off the screen at first)
|
||||
|
||||
* Select '**archlinux**'
|
||||
|
||||
* Select '**OK**' Press '**Enter**'
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
*Note: 'Setup' will close and will output the text of the created build.conf file as well as the needed **make** commands to build the template*
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
## 7: Install all the dependencies
|
||||
|
||||
*Note: make sure you are in the “qubes-builder” directory to run the following cmds*
|
||||
|
||||
* **$ make install-deps**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
## 8: Get all the require sources for the build: (Note: this may take some time)
|
||||
|
||||
* **$ make get-sources**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
## 9: Make all the require Qubes Components
|
||||
|
||||
* **Note:** You can run a single command to build all the Qubes components or you can run them each individually.
|
||||
Both ways below:
|
||||
|
||||
* Single command to build all Qubes components together: (this command can take a long time to process depending of your pc proccessing power)
|
||||
|
||||
* **$ make qubes-vm**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
|
||||
* These are the indivual component 'make' commands:
|
||||
|
||||
* **$ make vmm-xen-vm**
|
||||
|
||||
* **$ make core-vchan-xen-vm**
|
||||
|
||||
* **$ make core-qubesdb-vm**
|
||||
|
||||
* **$ make linux-utils-vm**
|
||||
|
||||
* **$ make core-agent-linux-vm**
|
||||
|
||||
* **$ make gui-common-vm**
|
||||
|
||||
* **$ make gui-agent-linux-vm**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
|
||||
## 10: Make the actual Archlinux template
|
||||
|
||||
* **$ make template**
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
## 11: Transfer Template into Dom0
|
||||
|
||||
* You need to ensure these two files are in the '**noarch**' directory
|
||||
|
||||
* **$ cd /home/user/qubes-builder/qubes-src/linux-template-builder/rpm/**
|
||||
|
||||
* **$ ls** *(confirm the below two files are there)*
|
||||
|
||||
* **install-templates.sh** (script to install template in dom0)
|
||||
|
||||
* **$ cd noarch**
|
||||
|
||||
* **$ ls**
|
||||
|
||||
* **qubes-template-archlinux-X.X.X-XXXXXXXXXXXX.noarch.rpm** (this is the template package 'X' replaces version and build digits)
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* **Transfer the install-templates.sh script file into Dom0**
|
||||
*Note: as there is not a typical file transfer method for Dom0, for security reasons, this less than simple transfer function has to be used*
|
||||
|
||||
* Swtich to Domo and open a terminal window.
|
||||
|
||||
**Note:** Take care when entering these cmd strings. They are very long and have a number of characters that are easy to mix '**-**' vs '**.**' '**<u>T</u>emplates** (correct) vs **<u>t</u>emplates** (wrong) or **Template_**'(also wrong) This script will also take care of transfering the actual template.rpm to Dom0 as well.
|
||||
|
||||
|
||||
* **$ cd /**
|
||||
|
||||
* **$ sudo qvm-run --pass-io development 'cat /home/user/qubes-builder/qubes-src/linux-template-builder/rpm/install-templates.sh' > install-templates.sh**
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
* If everything went correct there should be a Archlinux template listed in your Qubes VM Manager *
|
||||
|
||||
|
||||
# Known problems in building with Qubes R3.X
|
||||
|
||||
## Build fails when fetching qubes-mgmt-salt
|
||||
|
||||
The `qubes-mgmt-salt` repo is not currently forked under the marmarek user on
|
||||
GitHub, to whom the above instructions set the `GIT_PREFIX`. As Archlinux is
|
||||
not yet supported by mgmt-salt, simply leave it out of the build (when building
|
||||
the Archlinux template on it's own) by appending the following to your
|
||||
`builder.conf`:
|
||||
the Archlinux template on it's own) by appending the following to your `override.conf` file:
|
||||
|
||||
~~~
|
||||
BUILDER_PLUGINS := $(filter-out mgmt-salt,$(BUILDER_PLUGINS))
|
||||
~~~
|
||||
`BUILDER_PLUGINS := $(filter-out mgmt-salt,$(BUILDER_PLUGINS))`
|
||||
|
||||
The nm-applet (network manager icon) fails to start when archlinux is defined as a template-vm:
|
||||
-----------------------------------------------------------------------------------------------
|
||||
## The nm-applet (network manager icon) fails to start when archlinux is defined as a template-vm
|
||||
|
||||
In fact /etc/dbus-1/system.d/org.freedesktop.NetworkManager.conf does not allow a standard user to run network manager clients. To allow this, one need to change inside \<policy context="default"\>:
|
||||
|
||||
~~~
|
||||
<deny send_destination="org.freedesktop.NetworkManager"/>
|
||||
~~~
|
||||
`<deny send_destination="org.freedesktop.NetworkManager"/>`
|
||||
|
||||
to
|
||||
|
||||
~~~
|
||||
<allow send_destination="org.freedesktop.NetworkManager"/>
|
||||
~~~
|
||||
`<allow send_destination="org.freedesktop.NetworkManager"/>`
|
||||
|
||||
DispVM, Yum proxy and most Qubes addons (thunderbird ...) have not been tested at all.
|
||||
--------------------------------------------------------------------------------------
|
||||
## DispVM, Yum proxy and most Qubes addons (thunderbird ...) have not been tested at all
|
||||
|
||||
The sound does not work in AppVMs and there are messages related to pulse segfault in glibc when running dmesg (FIXED)
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
## Error when building the gui-agent-linux with pulsecore error
|
||||
|
||||
This is apparently a bug in Archlinux between glibc and pulseaudio package 4.0-6. The packages pulseaudio-4.0-2 and libpulse-4.0-2 are known to work and can be downloaded and reinstalled manually.
|
||||
|
||||
Error when building the gui-agent-linux with pulsecore error
|
||||
------------------------------------------------------------
|
||||
|
||||
~~~
|
||||
```
|
||||
module-vchan-sink.c:62:34: fatal error: pulsecore/core-error.h: No such file or directory
|
||||
#include <pulsecore/core-error.h>
|
||||
~~~
|
||||
```
|
||||
|
||||
This error is because Archlinux update package too quickly. Probably, a new version of pulseaudio has been released, but the qubes team has not imported the new development headers yet.
|
||||
|
||||
You can create fake new headers just by copying the old headers:
|
||||
|
||||
~~~
|
||||
```
|
||||
cd qubes-builder/qubes-src/gui-agent-linux/pulse
|
||||
ls
|
||||
cp -r pulsecore-#lastversion pulsecore-#archlinuxversion
|
||||
~~~
|
||||
```
|
||||
|
||||
You can check the current archlinux pulseaudio version like this:
|
||||
|
||||
~~~
|
||||
sudo chroot chroot-archlinux/ pacman -Qi pulseaudio
|
||||
~~~
|
||||
`sudo chroot chroot-archlinux/ pacman -Qi pulseaudio`
|
||||
|
||||
chroot-archlinux/dev/pts has not been unmounted
|
||||
-----------------------------------------------
|
||||
## chroot-archlinux/dev/pts has not been unmounted
|
||||
|
||||
This is a known problem when there are errors during building. Check what is mounted using the command mount (with no parameters). Just unmount what you can (or reboot your vm if you are too lazy :) )
|
||||
|
||||
Known problems in Qubes R2-B2
|
||||
=============================
|
||||
# Known problems in building with Qubes R2-B2
|
||||
|
||||
xen-vmm-vm fail to build with a PARSETUPLE related error (FIXED):
|
||||
-----------------------------------------------------------------
|
||||
## xen-vmm-vm fail to build with a PARSETUPLE related error (FIXED)
|
||||
|
||||
Commenting out "\#define HAVE\_ATTRIBUTE\_FORMAT\_PARSETUPLE" from chroot\_archlinux/usr/include/python2.7/pyconfig.h fixes the problem, but it isn't the right solution [1]...
|
||||
|
||||
@ -160,37 +397,31 @@ A better fix is planned for the next python release (the bug is considered relea
|
||||
|
||||
[1] [http://bugs.python.org/issue17547](http://bugs.python.org/issue17547)
|
||||
|
||||
The boot process fails without visible errors in the logs, but spawn a recovery shell
|
||||
-------------------------------------------------------------------------------------
|
||||
## The boot process fails without visible errors in the logs, but spawn a recovery shell
|
||||
|
||||
The problem is a new conflict between systemd and the old sysvinit style. To fix this, you can change the master xen template in dom0 to remove sysvinit remains: Edit **INSIDE DOM0** /usr/share/qubes/vm-template.conf, and change the variable 'extra' that contains the kernel variables: from:
|
||||
The problem is new conflict between systemd and the old sysvinit style. To fix this, you can change the master xen template in dom0 to remove sysvinit remains: Edit **INSIDE DOM0** /usr/share/qubes/vm-template.conf, and change the variable 'extra' that contains the kernel variables: from:
|
||||
|
||||
~~~
|
||||
extra="ro nomodeset 3 console=hvc0 rd_NO_PLYMOUTH {kernelopts}"
|
||||
~~~
|
||||
`extra="ro nomodeset 3 console=hvc0 rd_NO_PLYMOUTH {kernelopts}"`
|
||||
|
||||
to:
|
||||
|
||||
~~~
|
||||
extra="ro nomodeset console=hvc0 rd_NO_PLYMOUTH {kernelopts}"
|
||||
~~~
|
||||
`extra="ro nomodeset console=hvc0 rd_NO_PLYMOUTH {kernelopts}"`
|
||||
|
||||
Qubes-OS is now using different xenstore variable names, which makes to archlinux VM failing to boot
|
||||
----------------------------------------------------------------------------------------------------
|
||||
## Qubes-OS is now using different xenstore variable names, which makes to archlinux VM failing to boot
|
||||
|
||||
Apply the following fix in the template to revert the variable name to the old Qubes version.
|
||||
|
||||
You can edit the template the following way:
|
||||
|
||||
~~~
|
||||
```
|
||||
sudo mkdir /mnt/vm
|
||||
sudo mount /var/lib/qubes/vm-templates/archlinux-x64/root.img /mnt/vm
|
||||
sudo chroot /mnt/vm
|
||||
~~~
|
||||
```
|
||||
|
||||
Then apply the fix:
|
||||
|
||||
~~~
|
||||
```
|
||||
sudo sed 's:qubes-keyboard:qubes_keyboard:g' -i /etc/X11/xinit/xinitrc.d/qubes-keymap.sh
|
||||
|
||||
sudo sed 's:qubes-netvm-domid:qubes_netvm_domid:g' -i /etc/NetworkManager/dispatcher.d/30-qubes-external-ip
|
||||
@ -223,19 +454,23 @@ sudo sed 's:qubes-vm-updateable:qubes_vm_updateable:g' -i /usr/lib/qubes/qubes_t
|
||||
|
||||
sudo sed 's:qubes-vm-type:qubes_vm_type:g' -i /usr/bin/qubes-session
|
||||
sudo sed 's:qubes-vm-updateable:qubes_vm_updateable:g' -i /usr/bin/qubes-session
|
||||
~~~
|
||||
```
|
||||
|
||||
Do not forgot to:
|
||||
Do not forgot to unmount the VM:
|
||||
|
||||
~~~
|
||||
umount /mnt/vm
|
||||
~~~
|
||||
`umount /mnt/vm`
|
||||
|
||||
Installing the template in dom0 fails because of a missing dependency (qubes-core-dom0-linux)
|
||||
---------------------------------------------------------------------------------------------
|
||||
## Installing the template in dom0 fails because of a missing dependency (qubes-core-dom0-linux)
|
||||
|
||||
Again you built a template based on a recent Qubes API which has not been released yet. So skip the dependency for now:
|
||||
Again you built a template based on a recent Qubes API which has not been released yet. So skip the dependency for now
|
||||
|
||||
~~~
|
||||
sudo rpm -U --nodeps yourpackage.rpm
|
||||
~~~
|
||||
`sudo rpm -U --nodeps yourpackage.rpm`
|
||||
|
||||
|
||||
# Qubes Mailing List Threads on the Archlinux build process
|
||||
|
||||
* [Qubes-Devel](https://groups.google.com/forum/#!forum/qubes-devel): [Qubes Builder failed Archlinux repository is missing](https://groups.google.com/forum/#!topic/qubes-devel/tIFkS-rPVx8)
|
||||
|
||||
* [Qubes-Users](https://groups.google.com/forum/#!forum/qubes-users): [Trying to compile archlinux template](https://groups.google.com/forum/#!topic/qubes-users/7wuwr3LgkQQ)
|
||||
|
||||
<br>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user