Add troubleshooting documentation for when you receive 'Could not des…

…erialize key data' when using APNs with key files. (#286)
matrix-org · Dec 6, 2021 · 2ceb0c9 · 2ceb0c9
1 parent 37038c9
commit 2ceb0c9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/changelog.d/286.doc b/changelog.d/286.doc
@@ -0,0 +1 @@
+Add troubleshooting documentation for when you receive 'Could not deserialize key data' when using APNs with key files.
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -157,6 +157,13 @@ com.example.myapp.ios:
 in your Sygnal config file.
 
 
+### 'ValueError: Could not deserialize key data'
+
+This error suggests that your key file (`.p8` file) is not valid.
+If viewed with a text editor, the file should begin with `----- BEGIN PRIVATE KEY -----`.
+If yours doesn't, you probably have the wrong kind of file.
+
+
 # Appendices
 
 ## Sending a notification to Sygnal manually with `curl`