From 8a22c5c786f8a1457ece2d0d2eb5ad428fe4b5a5 Mon Sep 17 00:00:00 2001
From: voipmeister <12763807+voipmeister@users.noreply.github.com>
Date: Sun, 8 Sep 2024 14:55:09 +0200
Subject: [PATCH 1/3] Expanded config template for #563

---
 misc/config_template.in.hjson | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/misc/config_template.in.hjson b/misc/config_template.in.hjson
index 94fc02e64..911fd9681 100644
--- a/misc/config_template.in.hjson
+++ b/misc/config_template.in.hjson
@@ -157,6 +157,13 @@
             //
             //  3 - Finally, set 'enabled' to 'true'
             //
+            //  ! - If you receive the following error when starting ENiGMA:
+            //  "Error initializing: Error: Cannot parse privateKey: Unsupported key format"
+            //  You might need to convert your key. This can be done as follows:
+            //
+            //  > openssl rsa -in unsupported.key -out converted.key -traditional 
+            //
+            //
             //  Additional reading:
             //  - https://blog.sleeplessbeastie.eu/2017/12/28/how-to-generate-private-key/
             //  - https://gist.github.com/briansmith/2ee42439923d8e65a266994d0f70180b

From 4121dd3940bdc1637faf4735b28ad0054568e8e5 Mon Sep 17 00:00:00 2001
From: voipmeister <12763807+voipmeister@users.noreply.github.com>
Date: Sun, 8 Sep 2024 15:10:07 +0200
Subject: [PATCH 2/3] Updated ssh-troubleshooting.md for #536

---
 .../troubleshooting/ssh-troubleshooting.md    | 20 ++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/docs/_docs/troubleshooting/ssh-troubleshooting.md b/docs/_docs/troubleshooting/ssh-troubleshooting.md
index 4b59b4f59..786bcf100 100644
--- a/docs/_docs/troubleshooting/ssh-troubleshooting.md
+++ b/docs/_docs/troubleshooting/ssh-troubleshooting.md
@@ -20,7 +20,25 @@ Several things can cause this:
 1. `ssh_private_key.pem` was installed to the wrong location. Make sure that it is in the `config/security` directory and has the name matching the error message. You can also change your `config.hjson` if you prefer to point to the location of the key file.
 2. `ssh_private_key.pem` has the wrong file permissions. Verify that the file will be readable by the user that the BBS is running as. Because it is a cryptographic key however, we do recommend that access is restricted only to that user.
 
-## Error With Netrunner
+## Cannot parse privateKey: Unsupported key format
+
+***Symptom:***
+BBS not starting with an error similar to the following:
+
+```shell
+Error initializing: Error: Cannot parse privateKey: Unsupported key format
+```
+
+***Solution:***
+Depending on the OpenSSL version, a specific key format is used to generate the private key. The error above is observed on Debian 12 (Bookworm), but might present itself on other Debian 12 derivatives.
+
+Convert the unsupported key to a supported one:
+
+```shell
+openssl rsa -in unsupported.key -out converted.key -traditional
+```
+
+## Errors With Netrunner
 
 ***Symptom:***
 Some ssh clients connect, but Netrunner (and other older clients) get a connection failed message and the following is in the log:

From 07be786eb1e48284c6e3b0ebb3cabc4ab05c8797 Mon Sep 17 00:00:00 2001
From: voipmeister <12763807+voipmeister@users.noreply.github.com>
Date: Sun, 8 Sep 2024 15:11:47 +0200
Subject: [PATCH 3/3] Added link to project troubleshooting doc

---
 misc/config_template.in.hjson | 1 +
 1 file changed, 1 insertion(+)

diff --git a/misc/config_template.in.hjson b/misc/config_template.in.hjson
index 911fd9681..b2108f7f4 100644
--- a/misc/config_template.in.hjson
+++ b/misc/config_template.in.hjson
@@ -165,6 +165,7 @@
             //
             //
             //  Additional reading:
+            //  - https://nuskooler.github.io/enigma-bbs/troubleshooting/ssh-troubleshooting.html
             //  - https://blog.sleeplessbeastie.eu/2017/12/28/how-to-generate-private-key/
             //  - https://gist.github.com/briansmith/2ee42439923d8e65a266994d0f70180b
             //