Update

Author: LukeGus

docs/.vitepress/config.ts

@@ -33,18 +33,39 @@ export default defineConfig({
       {
         text: 'Documentation',
         items: [
-          {text: 'Installation', link: '/install'},
-          {text: 'OIDC', link: '/oidc'},
-          {text: 'Tunnels', link: '/tunnels'},
-          {text: 'JSON Import', link: '/json-import'},
-          {text: 'Contributing', link: '/contributing'},
           {
-            text: "API Reference",
+            text: 'Getting Started',
+            items: [
+              { text: 'Installation', link: '/install' },
+              { text: 'Contributing', link: '/contributing' },
+            ],
+          },
+          {
+            text: 'Authentication',
+            items: [
+              { text: 'OIDC', link: '/oidc' },
+              { text: 'TOTP', link: '/totp' },
+            ],
+          },
+          {
+            text: 'Networking',
+            items: [
+              { text: 'Tunnels', link: '/tunnels' },
+            ],
+          },
+          {
+            text: 'Data',
+            items: [
+              { text: 'JSON Import', link: '/json-import' },
+            ],
+          },
+          {
+            text: 'API Reference',
             collapsed: true,
-            link: "/api-reference",
+            link: '/api-reference',
             items: [...sidebar.generateSidebarGroups()],
           },
-        ]
+        ],
       },
     ],
 

docs/totp.md

@@ -0,0 +1,108 @@
+# Two-Factor Authentication (TOTP) Setup Guide
+
+## Overview
+
+Two-Factor Authentication (2FA) adds an extra layer of security to your account by requiring both your password and a time-based one-time password (TOTP) generated by an authenticator app. This guide will walk you through setting up, managing, and using 2FA in Termix.
+
+## Prerequisites
+
+Before setting up 2FA, ensure you have:
+
+- A smartphone or device with an authenticator app installed
+- A local username and password account, TOTP cannot be used with OIDC.
+
+## Recommended Authenticator Appsx
+
+- **Google Authenticator** (iOS/Android)
+- **Microsoft Authenticator** (iOS/Android)
+- **Authy** (iOS/Android/Desktop)
+- **1Password** (iOS/Android/Desktop)
+- **Bitwarden** (iOS/Android/Desktop)
+
+## Setting Up Two-Factor Authentication
+
+### Step 1: Initiate Setup
+
+1. Navigate to your **Profile & Security** section
+2. Click on the **Security** tab
+3. Click **"Enable Two-Factor Authentication"**
+
+### Step 2: Scan QR Code
+
+1. Termix will display a QR code
+2. Open your authenticator app and scan the QR code
+3. Alternatively, you can manually enter the secret key shown below the QR code
+
+### Step 3: Verify Setup
+
+1. Your authenticator app will generate a 6-digit code
+2. Enter this code in the verification field
+3. Click **"Verify and Enable"**
+
+### Step 4: Save Backup Codes
+
+1. After successful verification, you'll receive backup codes
+2. Download or copy these codes
+3. Each backup code can only be used once
+4. Click **"Complete Setup"** to finish
+
+## Using Two-Factor Authentication
+
+### Daily Login
+
+1. Enter your username and password as usual
+2. When prompted, open your authenticator app
+3. Enter the 6-digit code displayed in your app
+
+### Code Generation
+
+- TOTP codes refresh every 30 seconds
+- Each code is valid for a limited time
+- If a code expires, wait for the next one to appear
+
+## Managing Your 2FA Settings
+
+### Viewing Status
+
+- Check the **Security** tab in your User Profile
+- The status will show as "Enabled" with a green shield icon
+
+### Disabling 2FA
+
+1. Go to the **Security** tab
+2. Click on **"Disable 2FA"**
+3. Enter either:
+    - Your account password, OR
+    - A valid TOTP code from your authenticator app
+4. Click **"Disable Two-Factor Authentication"**
+
+### Managing Backup Codes
+
+#### Generate New Backup Codes
+
+If you've lost your existing backup codes:
+
+1. Go to the **Security** tab
+2. Click on **"Backup Codes"**
+3. Enter your password or TOTP code
+4. Click **"Generate New Backup Codes"**
+5. Save the new codes
+
+#### Download Backup Codes
+
+1. Click the **"Download"** button next to your backup codes
+2. A text file will be downloaded containing all your codes
+3. Store this file in a secure location
+
+## Backup Codes
+
+### What Are Backup Codes?
+
+Backup codes are one-time use codes that allow you to access your account if you:
+- Lose your authenticator device
+- Can't access your authenticator app
+
+### Using Backup Codes
+
+1. During login, when prompted for a TOTP code
+2. Enter one of your backup codes instead of a regular TOTP code