From 71cce9306274a841118efafbf6bcb4622bf8d246 Mon Sep 17 00:00:00 2001
From: Antoine Martin <dev@ayakael.net>
Date: Thu, 22 Aug 2024 12:18:31 -0400
Subject: [PATCH] README: install info

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

diff --git a/README.md b/README.md
index c7a5cdf..13bc7fe 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,68 @@ Thus the following use cases are still not supported / tested:
  * `qubes-vm-kernel-support` Not adapted for use on Alpine yet, due to it providing a Dracut module. In most cases, it is not necessary as Qubes provides the kernel. 
    This package is only neccessary when VM uses its own kernel, thus a hook is added to Dracut to generate the initrd for use within qubes.
 
+## How to install
+
+First, we need to transfer to dom0 the template key.
+
+**Within VM, download template key:**
+
+```
+curl -JO https://ayakael.net/api/packages/forge/rpm/repository.key
+```
+
+**On dom0, transfer and copy key to key store:**
+
+```
+qvm-run -p <curl-vm> 'cat </path/to/downloaded/key ' > repository.key
+sudo mv repository.key /etc/qubes/repo-templates/keys/RPM-GPG-KEY-ayakael-forge
+```
+
+For installation, you have two options.
+
+### Using qvm-template
+
+**1) Create repository definition**
+
+On dom0, create and edit `/etc/qubes/repo-templates/ayakael-forge-r42.repo` to match the following
+
+```
+[ayakael-forge-qubes-r42]
+name=forge - Ayakael - qubes - r42
+baseurl=https://ayakael.net/api/packages/forge/rpm/qubes/r42
+enabled=1
+gpgcheck=1
+gpgkey = file:////etc/qubes/repo-templates/keys/RPM-GPG-KEY-ayakael-forge
+```
+
+**2) Install template**
+
+```
+qvm-template install alpine320
+```
+
+### Manually
+
+**1) Download and transfer template RPM**
+
+
+On VM, download desired template RPM available in `Packages` section
+```
+curl -JO https:<url/rpm>
+```
+
+On dom0, transfer RPM
+
+```
+qvm-run -p <curl-vm> 'cat </path/to/downloaded/rpm ' > qubes-template-alpine.rpm
+```
+
+**2) Install template**
+
+```
+qvm-template --keyring /etc/qubes/repo-templates/keys/RPM-GPG-KEY-forge-ayakael install $(pwd)/qubes-template-alpine.rpm
+```
+
 ## How to build
 
 Since this template builder uses pre-built Alpine Linux packages for QubesOS template support, it by defaults does not build everything locally. If you want to build them locally, you can follow these steps. If not, you can skip to the next section.