From 1d4100dcc01160ac225a4aeef6e57b3cfeda2dcd Mon Sep 17 00:00:00 2001
From: Vadim Troshchinskiy <vtroshchinskiy@qindel.com>
Date: Mon, 13 Jan 2025 15:56:10 +0100
Subject: [PATCH] Update english documentation

---
 installer/README-en.md | 45 ++++++++++++++++++++++++++++++++++++------
 1 file changed, 39 insertions(+), 6 deletions(-)

diff --git a/installer/README-en.md b/installer/README-en.md
index f14eb9a..1009fda 100644
--- a/installer/README-en.md
+++ b/installer/README-en.md
@@ -1,20 +1,48 @@
-# Installing Dependencies for Python
+# Git component installer
 
-Converting the code to Python 3 currently requires the packages specified in `requirements.txt`.
+This directory contains the installer for the git component for OpenGnsys.
 
-To install Python dependencies, the `venv` module (https://docs.python.org/3/library/venv.html) is used, which installs all dependencies in an isolated environment separate from the system.
+It downloads, installs and configures Forgejo, creates the default repositories and configures SSH keys.
 
 # Quick Installation
 
 ## Ubuntu 24.04
 
-    sudo apt install python3-git opengnsys-libarchive-c python3-termcolor bsdextrautils
+### Add the repository
+
+
+Create the file `/etc/apt/sources.list.d/opengnsys.sources` with these contents:
+
+    Types: deb
+    URIs: https://ognproject.evlt.uma.es/debian-opengnsys/
+    Suites: noble
+    Components: main
+    Signed-By:
+     -----BEGIN PGP PUBLIC KEY BLOCK-----
+     .
+     mDMEZzx/SxYJKwYBBAHaRw8BAQdAa83CuAJ5/+7Pn9LHT/k34EAGpx5FnT/ExHSj
+     XZG1JES0Ik9wZW5HbnN5cyA8b3Blbmduc3lzQG9wZW5nbnN5cy5lcz6ImQQTFgoA
+     QRYhBC+J38Xsso227ZbDVt2S5xJQRhKDBQJnPH9LAhsDBQkFo5qABQsJCAcCAiIC
+     BhUKCQgLAgQWAgMBAh4HAheAAAoJEN2S5xJQRhKDW/MBAO6swnpwdrbm48ypMyPh
+     NboxvF7rCqBqHWwRHvkvrq7pAP9zd98r7z2AvqVXZxnaCsLTUNMEL12+DVZAUZ1G
+     EquRBbg4BGc8f0sSCisGAQQBl1UBBQEBB0B6D6tkrwXSHi7ebGYsiMPntqwdkQ/S
+     84SFTlSxRqdXfgMBCAeIfgQYFgoAJhYhBC+J38Xsso227ZbDVt2S5xJQRhKDBQJn
+     PH9LAhsMBQkFo5qAAAoJEN2S5xJQRhKDJ+cBAM9jYbeq5VXkHLfODeVztgSXnSUe
+     yklJ18oQmpeK5eWeAQDKYk/P0R+1ZJDItxkeP6pw62bCDYGQDvdDGPMAaIT6CA==
+     =xcNc
+     -----END PGP PUBLIC KEY BLOCK-----
+
+It's required to run `apt update` after creating this file
+
+### Install packages
+
+    sudo apt install -y python3-git opengnsys-libarchive-c python3-termcolor python3-requests bsdextrautils
 
 ## Add SSH Keys to oglive
 
 The Git system accesses the ogrepository via SSH. To work, it needs the oglive to have an SSH key, and the ogrepository must accept it.
 
-The Git installer can make the required changes with:
+The Git installer can make the required changes in the Forgejo configuration by extracting a key from the oglive. When invoked without arguments, it extracts the key from the default oglive. This process can also be done by hand, with:
 
     ./opengnsys_git_installer.py --set-ssh-key
 
@@ -24,7 +52,12 @@ Or to do it for a specific oglive:
 
 Running this command automatically adds the SSH key to Forgejo.
 
-The existing key can be extracted with:
+It's also possible to specify a squashfs file, for the cases where the Git component is not installed on the same machine as ogboot. To do this, copy the squashfs image over, and run the installer with the `--squashfs-file` argument, like this:
+
+    ./opengnsys_git_installer.py --set-ssh-key --squashfs-file /home/user/initrd.sqfs
+
+
+The existing key can be dumped to the console with:
 
     ./opengnsys_git_installer.py --extract-ssh-key --quiet