Merge pull request #45 from brentru/add-securing-page

Add "Securing your Adafruit IO Account" to cookbook pages
adafruit · Oct 16, 2023 · f7ce28b · f7ce28b
2 parents 2314c1c + 10f9603
commit f7ce28b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/source/cookbook.html.erb b/source/cookbook.html.erb
@@ -29,6 +29,7 @@ includes:
   - cookbook/images.md.erb
   - cookbook/sending_json.md.erb
   - cookbook/webhook_receivers.md.erb
+  - cookbook/securing_io_account.md.erb
 
 search: true
 ---

diff --git a/source/includes/cookbook/_securing_io_account.md.erb b/source/includes/cookbook/_securing_io_account.md.erb
@@ -0,0 +1,17 @@
+# Securing your IO Account
+
+Your IO Account includes a secret API key. This key is private and should not be shared with anyone.
+
+But, a common pitfalls of the key is it may be accidentally shared by posted code on GitHub or social media. If anyone gains access to your key, **they will have access to your Adafruit IO account**.
+
+## I accidentially shared my key, what do I do now?
+
+You'll need to generate a new key. This process is simple, but not reversable. Once you generate a new key for your Adafruit IO account,
+all devices using the previous Adafruit IO key will need to be updated to the new key.
+
+
+To rengenerate your Adafruit IO Key:
+* Navigate to io.adafruit.com and log into your account.
+* Click the key icon on the header.
+* Click the "Regenerate Key" button and confirm the action.
+* The value of "Active Key" will change to a new key. Replace all instances of the previous key with the new one.