Merge pull request #51 from chrizzo-hb/main

How to SSH, how to SCP, how to apply patches and/or create overlays

docs/configure/patches-and-overlays.md

@@ -0,0 +1,201 @@
+#  :material-layers-plus: Patches and Overlays
+
+!!! danger "Important: Read this before you start!"
+
+    This section deals with adding **patches** to your KNULLI installation **manually**. This is **not** a guide for **regular updates**. Please be absolutely aware that this guide is just a kick-off guide for **advanced users** who want to learn more about Linux and apply manual changes to their KNULLI installation.
+
+    If you are looking for information on how to update your KNULLI device regularly, please head to the [Update](../../play/update) section instead!
+
+!!! warning "SSH network access to your device is mandatory"
+
+    Before reading any further, be aware that it is **mandatory** to be able to access a command line on your KNULLI device via **SSH** to **install patches** and **create overlays**. Consequently, you will **not** be able to do either unless your device is connected to your Wi-Fi (as explained in the [Networking](../networking) section) and you have prepared SSH access to your device  (as explained in the [SSH](../ssh) section).
+
+This section covers details about installing **patches** and persisting changes to the operating system in an **overlay**. As a **regular KNULLI user**, you probably do **not** need to know any of this. This entire section is written for two groups of users:
+
+* **Community members** from our [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB) who want to try patches **before** they are included in a new internal or public build.
+* **Advanced users** who know their way around Linux and want to make changes to their KNULLI setup.
+
+## Understanding Linux file systems
+
+If you are a Windows user who has never worked with Linux before, you might want to take a little time to understand how Linux file systems work. Bare in mind that this is a **simplified** explanation which is only meant to pick you up and give you a brief understanding of how KNULLI works differently from your Windows PC. If you want to learn more about how Linux work, we **strongly** recommend to find a more extensive source of information.
+
+### File systems on Windows machines
+
+On your Windows computer, each **drive** (or **partition**) has an assigned **drive letter**. You might think about them like labeled drawers of a filing cabinet. The **main drive** that hosts your Windows installation traditionally uses the drive letter `C:` - this is a relic of a time when drive letters `A:` and `B:` where reserved for the two floppy disc drives computers used to have. However, if you connect another drive to your PC, like a thumb drive or a SD card, Windows automatically assigns new drive letters to them, so you can access those drives from your *Windows Explorer*. Files and folders are addressed by their **absolute path** which starts with the **drive letter**. E.g., the folder which holds your pictures is located at
+
+```
+C:\Users\<username>\Pictures
+```
+
+### File systems on Linux machines 
+
+Linux filesystems work a little different. On Linux, every **drive** is treated like a **folder**. A Linux system always has a so called **root** that **loosely** corresponds conceptually to the drive letter `C:` on a Windows machine. The **root** is always referred to by the symbol `/`. By definition, each **absolute path** always starts with `/` symbol.
+
+Other **drives** are treated like **subfolders** of the **root**. With a command called `mount`, any **empty folder** on a Linux system can be assigned to **any drive** of the device. It is even allowed, to have **more than one folder** that points to **the same drive**. Following the previous metaphor, consider a filing cabinet with only a **single drawer**.
+
+For example, on your KNULLI device, your games are stored in
+
+```
+/userdata/roms
+```
+
+### The KNULLI file system
+
+KNULLI is a Linux, so it uses a Linux file system. The entire KNULLI system is stored in a **read-only** SquashFS. (You can learn more about SquashFS on [Wikipedia](https://en.wikipedia.org/wiki/SquashFS).) The **only exception** is a **writable** folder called `/userdata`.
+
+During boot, KNULLI uses the `mount` command to make the folder `/userdata` point to a **writable** drive. By switching between **internal** and **external** storage (as explained in the [Second SD Card](../../play/add-games/second-sd-card) section), you tell KNULLI which **drive** to mount as `/userdata` during boot:
+
+* If you use a **single SD card** setup (**internal** storage), KNULLI mounts the `SHARE` partition of **SD 1**.
+* If you use a **dual SD card** setup (**external** storage), KNULLI mounts the main partition of **SD 2**.
+
+When accessing your KNULLI device via Windows/SMB network transfer (as explained in the [Network Transfer](../../play/add-games/network-transfer) section), you will access a network drive called `share` that corresponds **exactly** to your **current** `/userdata` folder. The SMB address
+
+```
+\\KNULLI\share
+```
+
+points to the exact same place as the absolute path
+
+```
+/userdata
+```
+
+on your KNULLI device.
+
+The [Game Storage](../../play/add-games/game-storage) section covers in great detail how to use the **writable** part of your device to add games, BIOS files, bezel decorations, etc. However, when you want to install **patches**, you want to modify files **outside** of the writable `/userdata` folder - that is, where the **overlay** comes into play.
+
+#### Many ways lead to Rome
+
+Keep in mind that Linux allows multiple paths to the same files and folders:
+
+```
+/media/SHARE
+```
+
+points to your **internal** storage while
+
+```
+/media/SHARE_1
+```
+
+points to your **external** storage (if you have a dual SD card setup).
+
+Consequently, on a **single SD card setup**, the paths
+
+```
+/media/SHARE/system/batocera.conf
+```
+
+and
+
+```
+/userdata/system/batocera.conf
+```
+
+point **to the exact same file**.
+
+Following that principle, on a **dual SD card setup**, the paths
+
+```
+/media/SHARE_1/system/batocera.conf
+```
+
+and
+
+```
+/userdata/system/batocera.conf
+```
+
+point **to the exact same file**, too.
+
+## The overlay
+
+Since everything outside of the `/userdata` folder of your KNULLI installation is **read-only** by definition, you will need to create an **overlay** to make **permanent** changes to your KNULLI installation. Otherwise, all changes will simply be undone after every reboot of your system.
+
+Your primary SD card (SD1) has a drive called `BATOCERA`, which is formatted to **FAT32** and can be accessed easily from Windows, Linux, and MacOS. On that drive, you will find a folder called `boot` which contains a **file** called `batocera` - that file contains the **majority of your KNULLI installation**. (This is why you can manually update your KNULLI installation by simply replacing this file, as explained in the [Update](../../play/update) section.
+
+The **overlay** is **another** file that is just called `overlay` and resides in the same folder. The overlay is **optional** - usually, users do **not** have an overlay in place. The **overlay file** contains **changes** you made to the KNULLI installation, which will be applied **during boot**.
+
+!!! danger "Important: Undo changes"
+
+    If you have created an overlay that breaks your system, you can always **undo** all your changes by simply **deleting** the **`overlay` file** from the `boot` folder of your `batocera` partition.
+
+    We **strongly recommend** to **always remove** your current overlay when you **update** your KNULLI installation, because patches and other modifications stored in the overlay might be **in conflict** with the new KNULLI version.
+
+## Installing patches (or manual modifications)
+
+!!! warning "Patches"
+
+    Some community members on our [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB) server occasionally provide patches you can install **manually**. These patches are usually new features which are either **considered** or already **confirmed** to be included in a future KNULLI release. Be aware that patches might be **experimental** and sometimes just a **prototype** for a final solution!
+
+    By installing a patch and reporting feedback to the developers, you provide valuable assistance to the development of KNULLI. However, patches are often not yet approved by the community or the lead developers of the KNULLI project, consequently, there are no guarantees that they will work for **you**.
+
+    Before installing a patch, make sure you find the source **trustworthy**.
+
+Most patch installations (or manual modifications) to your KNULLI system follow a simple pattern:
+
+* Add, replace, or remove files **outside** of your `/userdata` folder
+* Make some of the files **executable** by applying the command `chmod +x` to the files.
+* **Create** or **update** your **overlay** by executing the command `batocera-save-overlay` which makes all the changes persistent.
+* Reboot your device.
+
+Some developers **simplify** this process for you, by providing a **patch installer** which does most of these steps for you. However, even if you received a patch installer, you will still have to make the patch installer **executable** and run it from an SSH command line.
+
+### Putting files into the right places
+
+There are several options to put files in the right places **outside** of the `/userdata` folder.
+
+* Some patches come with a **patch installer** which moves the file for you. In this case, simply store the **patch installer** and all patch files in your `/userdata` folder according to the specifications made by the developer.
+* You can use SCP/FTP to access the entire KNULLI file system. You will find a subsection on how to use SCP/FTP in the [Network Transfer](../../play/add-games/network-transfer) section. This approach allows to put the files **directly** to their **final destination**.
+* You can copy the files to your `/userdata` folder by the same method you add your games and BIOSes. Afterwards, you can move the files **from** their location inside `/userdata` **to** their **final destination**
+    * **either** by using the *OD-Commander* tool you will find in the *Ports* category of your KNULLI device
+    * **or** by connecting via SSH (as explained in the [SSH](../ssh) section) and copying/moving the files via `cp`/`mv` on the command line, e.g.,
+    ```
+    cp /userdata/system/some-file.sh /usr/bin/some-file.sh
+    ```
+    or
+    ```
+    mv /userdata/system/some-file.sh /usr/bin/some-file.sh
+    ```    
+    
+### Making files executable
+
+After you have moved the files in the right places, you need to make sure that all files which are **supposed** to be executable **actually are** executable. Again, you have several options to achieve this:
+
+* If using WinSCP, you can right-click a file and select *Properties*.
+    * In the *Common* tab, go to the *Permissions* section and make sure all the *X*es are **checked** if the file is required to be **executable**.
+* If connected via SSH (as explained in the [SSH](../ssh) section), you can
+    * use the `ls` command to check the permissions of a file, e.g.,
+    ```
+    ls -l /userdata/system/patch-installer.sh
+    ```
+    to see if a file called `patch-installer.sh` is executable. The response will look like
+    ```
+    -rwxr-xr-x 1 root root 458 Aug  3 22:20 /userdata/system/patch-installer.sh
+    ```
+    and you can tell from the part `rwxr-xr-x` if a file is executable (you see 3 `x` letters) or not (you see less than 3 or even no `x` letters).
+    * use the `chmod` command to change the permissions of a file and make it executable, e.g.,
+    ```
+    chmod +x /userdata/system/patch-installer.sh
+    ```
+
+### If provided: Run the patch installer
+
+If your patch came with a **patch installer** which you have made executable in the previous step, you can now **execute** the patch installer from the SSH command line. To do so, establish a SSH connection (as explained in the [SSH](../ssh) section) and launch the installer by calling the script by its name from the command line (**Mind the dot** at the beginning of the command!), e.g.,
+```
+./userdata/system/patch-installer.sh
+```
+
+Have a close look at the output of this command, maybe copy-paste it to a text file for debugging purposes and reach out to the [:simple-discord: Discord](https://discord.gg/HXPS3DAeeB) community if you have problems understanding the output.
+
+### If required: Create overlay manually
+
+Some **patch installers** implicitly create or update the **overlay**. However, some do not. If your patch did **not** come with a patch installer, if you want to patch in your **own modifications**, or if you are not sure whether the patch you applied created an overlay, you better do it yourself. To do so, establish a SSH connection (as explained in the [SSH](../ssh) section) and execute the following command:
+```
+batocera-save-overlay
+```
+Once the overlay was created/updated successfully, you can type
+```
+reboot
+```
+to reboot your system and check if your changes are still in place afterwards.

docs/configure/ssh.de.md

@@ -6,6 +6,54 @@ Um mit deinem KNULLI-Gerät eine SSH-Verbindung aufzubauen, musst du das Gerät
 
 Um die SSH-Verbindung aufzubauen benötigst du dann die folgenden Informationen:
 
-* Host: Entweder der Hostname deines KNULLI-Gerätes oder die aktuelle IP-Adresse (drücke ++"Start"++ und wähle *Network settings* um deine aktuelle IP-Adresse einzusehen)
+* Host: Entweder der Hostname deines KNULLI-Gerätes (der Standard-Hostname lautet `KNULLI`) oder die aktuelle IP-Adresse (drücke ++"Start"++ und wähle *Network settings* um deine aktuelle IP-Adresse einzusehen)
 * Username: `root`
-* Passwort: Dein aktuelles Root-Passwort (drücke ++"Start"++ und wähle *System settings* und dann *Security* um dein aktuelles Root-Passwort einzusehen)
+* Passwort: Dein aktuelles Root-Passwort (drücke ++"Start"++ und wähle *System settings* und dann *Security* um dein aktuelles Root-Passwort einzusehen, das Standardpasswort lautet `linux`)
+
+Um eine SSH-Verbindung via SmarTTY aufzubauen, installiere das Programm, starte es und folge diesen Schritten:
+
+<table>
+	<tr>
+		<td>
+			<img src="/_inc/images/configure/ssh/smartty-new-connection-001.png">
+			<p><strong>Schritt 1: </strong>Klick auf <em>New SSH connection...</em> am unteren linken Rand des Fensters.<p>
+		</td>
+		<td>
+			<img src="/_inc/images/configure/ssh/smartty-new-connection-002.png">
+	    	<p><strong>Schritt 2: </strong>Richte eine neue SSH-Verbindung mit den folgenden Einstellungen ein und klick auf <em>Connect</em>.</p>
+			<table>
+				<tr>
+					<th>Host Name:</th>
+					<td><code>KNULLI</code></td>
+				</tr>
+				<tr>
+					<th>User Name:</th>
+					<td><code>root</code></td>
+				</tr>
+				<tr>
+					<th>Password:</th>
+					<td><code>linux</code></td>
+				</tr>
+				<tr>
+					<td colspan=2>
+						<strong>Zusätzlich auswählen:</strong>
+						<ul>
+							<li>Setup public key authentication and don't ask for password again</li>
+							<li>Save this connection to connections list</li>
+						</ul>
+					</td>
+				</tr>
+			</table>
+		</td>
+	</tr>
+	<tr>
+		<td>
+			<img src="/_inc/images/configure/ssh/smartty-new-connection-003.png">
+			<p><strong>Schritt 3: </strong>Wenn du gefragt wirst, welche Art von Terminal du benutzen möchtest, wähle <em>Regular Terminal</em>.</p>
+		</td>
+		<td>
+			<img src="/_inc/images/configure/ssh/smartty-new-connection-004.png">
+			<p><strong>Schritt 4: </strong>Du hast erfolgreich eine SSH-Verbindung zu deinem KNULLI-Gerät hergestellt.</p>
+		</td>
+	</tr>
+</table>

docs/configure/ssh.md

@@ -6,6 +6,54 @@ To connect to your KNULLI device via SSH, simply connect the device to your loca
 
 When establishing your SSH connection, you will need the following information:
 
-* Host: Either the hostname of your KNULLI device or the current IP address (press ++"Start"++ and go to *Network settings* to find your current IP address)
+* Host: Either the hostname of your KNULLI device (default is `KNULLI`) or the current IP address (press ++"Start"++ and go to *Network settings* to find your current IP address)
 * Username: `root`
-* Password: Your current root password (press ++"Start"++ and go to *System settings* and *Security* to find your current root password)
+* Password: Your current root password (press ++"Start"++ and go to *System settings* and *Security* to find your current root password, default is `linux`)
+
+To establish a SSH connection via SmarTTY, install and launch the program, then follow these steps:
+
+<table>
+	<tr>
+		<td>
+			<img src="/_inc/images/configure/ssh/smartty-new-connection-001.png">
+			<p><strong>Step 1: </strong>Click <em>New SSH connection...</em> at the bottom left of the window.<p>
+		</td>
+		<td>
+			<img src="/_inc/images/configure/ssh/smartty-new-connection-002.png">
+	    	<p><strong>Step 2: </strong>Setup a new SSH connection with the following settings and click <em>Connect</em>.</p>
+			<table>
+				<tr>
+					<th>Host Name:</th>
+					<td><code>KNULLI</code></td>
+				</tr>
+				<tr>
+					<th>User Name:</th>
+					<td><code>root</code></td>
+				</tr>
+				<tr>
+					<th>Password:</th>
+					<td><code>linux</code></td>
+				</tr>
+				<tr>
+					<td colspan=2>
+						<strong>Also check:</strong>
+						<ul>
+							<li>Setup public key authentication and don't ask for password again</li>
+							<li>Save this connection to connections list</li>
+						</ul>
+					</td>
+				</tr>
+			</table>
+		</td>
+	</tr>
+	<tr>
+		<td>
+			<img src="/_inc/images/configure/ssh/smartty-new-connection-003.png">
+			<p><strong>Step 3: </strong>When prompted for a type of virtual terminal, choose a <em>regular Terminal</em>.</p>
+		</td>
+		<td>
+			<img src="/_inc/images/configure/ssh/smartty-new-connection-004.png">
+			<p><strong>Step 4: </strong>You have successfully established a SSH connection to your KNULLI device.</p>
+		</td>
+	</tr>
+</table>