mfa docs.

gigalixir · Nov 8, 2020 · 24fd479 · 24fd479
1 parent 52426c6
commit 24fd479
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/docs/source/account.rst b/docs/source/account.rst
@@ -119,6 +119,37 @@ How to Log In
 
 This modifies your ~/.netrc file so that future API requests will be authenticated. API keys never expire, but can be revoked.
 
+How to use  multi-factor authentication
+=======================================
+
+Also known as 2-factor authentication or 2fa, this gives your account an extra layer of security so someone with just your password still won't be able to login to your account.
+
+To activate mfa with the CLI, first make sure you have version 1.2 or higher. To upgrade your CLI. See :ref:`cli-upgrade`.  Then run
+
+.. code-block:: bash
+
+    gigalixir account:mfa:activate
+
+This logs you out, so re-login.
+
+.. code-block:: bash
+
+    gigalixir login 
+
+Also, try it out on the web console: https://console.gigalixir.com/#/login
+
+To deactivate, run
+
+.. code-block:: bash
+
+    gigalixir account:mfa:deactivate
+
+To regenerate recovery codes, run
+
+.. code-block:: bash
+
+    gigalixir account:mfa:recovery_codes:regenerate
+
 How to Check Account Status
 ===========================
 

diff --git a/docs/source/cli.rst b/docs/source/cli.rst
@@ -16,6 +16,8 @@ If you're interested in creating a macOS Brew formula, :ref:`contact us!<help>`
 
 If you're interested in creating an Ubuntu/Debian package, :ref:`contact us!<help>`
 
+.. _`cli-upgrade`:
+
 How to Upgrade the CLI
 ----------------------