From 7bc36201db69991bd450d32bead9c4946e5f2c27 Mon Sep 17 00:00:00 2001 From: Simon Asika Date: Sat, 1 Jun 2024 14:32:16 +0800 Subject: [PATCH] Add documentations --- .vitepress/config.mts | 17 +++++---- .vitepress/theme/style.css | 7 ++++ docs/authentication.md | 75 ++++++++++++++++++++++++++++++++++++++ docs/index.md | 41 +++++++++++++++++++++ docs/token-managements.md | 71 ++++++++++++++++++++++++++++++++++++ 5 files changed, 203 insertions(+), 8 deletions(-) create mode 100644 docs/authentication.md create mode 100644 docs/index.md create mode 100644 docs/token-managements.md diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 8b8c795..ed0dd23 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -35,7 +35,7 @@ export default defineConfig({ // https://vitepress.dev/reference/default-theme-config nav: [ { text: 'Home', link: '/' }, - // { text: 'Examples', link: '/markdown-examples' }, + { text: 'Guide', link: '/docs/' }, { text: 'FAQs', link: '/faqs' }, { text: 'Privacy Policy', link: '/privacy-policy' }, ], @@ -64,13 +64,14 @@ export default defineConfig({ ], sidebar: [ - // { - // text: 'Examples', - // items: [ - // { text: 'Markdown Examples', link: '/markdown-examples' }, - // { text: 'Runtime API Examples', link: '/api-examples' } - // ] - // }, + { + text: 'Guide', + items: [ + { text: 'Installation', link: '/docs/' }, + { text: 'Authentication', link: '/docs/authentication' }, + { text: 'Token Managements', link: '/docs/token-managements' } + ] + }, { text: 'FAQs', link: '/faqs', diff --git a/.vitepress/theme/style.css b/.vitepress/theme/style.css index 74a9967..effee9a 100644 --- a/.vitepress/theme/style.css +++ b/.vitepress/theme/style.css @@ -173,3 +173,10 @@ } } } + +/* Docs */ +.vp-doc { + & img { + border: 1px solid rgba(255, 255, 255, .25); + } +} diff --git a/docs/authentication.md b/docs/authentication.md new file mode 100644 index 0000000..7496df1 --- /dev/null +++ b/docs/authentication.md @@ -0,0 +1,75 @@ +--- +layout: doc +--- + +# Authentication + +## Sign Up + +When you first open Authman, you may not have account yet, click `Create an account` +and go to sign up page: + +signup + +Enter you email and password to sign-up, currently we won't send verify email to user, so make sure you enter correvt personal email and use a strong password to protect your account. + +account + +After signed-up, you will auto login to Authman, please check [Token Managements](./token-managements.html) + to see how to create your first token. + +## Sign In + +If you sign-out of Authman, or install on a new device, you must re-login to Authman. Just fill your email and password to sign-in. + +signin + +Note, Authman use your password to encrypt & decrypt your all tokens, if you forgot your password, currently it is no way to take your 2FA tokens back. Please see [FAQ](/faqs.html) to know how we protect your key and data. + +## Screen Lock + +Authman will auto lock your app if user has no any actions over 5 minutes. + +lock + +All decrypted tokens will release when app lock, you must provide your password to unlock, since we use your password to encrypt tokens, the password is necessary to re-decrypt tokens after unlock. + +### Touch ID & Face ID + +If you are tired to enter password to unlock every time, you can enable the Biometrics unlock mode. Go to **Options** and enable the Biometrics toggler. Authman will ask your password again and save the [KEK](/faqs.html#how-authman-encrypt-keys-by-my-password) (which is derived from your password.) in device secure storage. Next time you can unlock device by Touch ID or Face ID and without entering password. + +bio + +> [!IMPORTANT] +> Authman will never store your password. + +## Change Password + +You could go to **Options > Change Password** to change your current password. + +change-password + +You must provide your old password to unlock secret keys first, that you can enter new password to re-encrypt secret keys by your new password. + +See also: [How Authman encrypt keys by my password?](/faqs.html#how-authman-encrypt-keys-by-my-password) + +> [!IMPORTANT] +> If you forgot your current password, currently there is no any way to reset it. +> We are considering to provide a recover code or account clear options in the future. + +## Sign-out from All Devices + +Currently, Authman didn't log all your sign-in devices, so we don't provide a device managements. + +If you missing you phone or you want to clear all sessions of your account, just go to **Options > My Account** and click the `Sign-Out from All My Devices`, Authman will make all API tokens expired. After this action, you must re-login again of current device. + +sign-out all + +## Delete Account + +If you no-longer want to use Authman, just go to **Options > My Account** and click the `Delete My Account` option. + +del account + + +Authman will delte you account and all tokens with no any backup, note this action cannot undo. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..744cbdf --- /dev/null +++ b/docs/index.md @@ -0,0 +1,41 @@ +--- +layout: doc +--- + +# Installation + +## Platforms + +Authman now supports there platforms: + +- iOS +- Android +- Windows (nsis) +- macOS (App Store or dmg) + +We are still working for platforms below: + +- Windows Store +- Linux + +## Mobile + +You can install Authman from iOS AppStore and Android Google Play + +- [iOS App Store](https://apps.apple.com/us/app/authman-2fa/id6502499482) +- [Google Play](https://play.google.com/store/apps/details?id=io.authman) + +## Desktop + +For Windows, please download the nsis setup package. + +- [Download Link](https://github.com/simular/authman-app/releases/latest) + +For macOS, there are 2 installation ways: + +- Download the dmg: [Download Link](https://github.com/simular/authman-app/releases/latest) +- Install from [Mac App Store](https://apps.apple.com/us/app/authman-2fa/id6502499482) + +## Build from Source + +This section still work in process. diff --git a/docs/token-managements.md b/docs/token-managements.md new file mode 100644 index 0000000..5ac4baa --- /dev/null +++ b/docs/token-managements.md @@ -0,0 +1,71 @@ +--- +layout: doc +--- + +# Token Managements + +## Create A New Token + +Click `New` on the header bar: + +header + +You may enter the TOTP secret or just scan QRCode by click the `Scan QRcode` button: + +qrcode + +After secret and title filled, click `Next` to configure the token icon: + +icon + +You can search icon from font-awesome, and set the color from color options. You can also upload the logo you prepared or just copy / paste from browser. + +> [!NOTE] +> All images will convert to a small png file. + +After you select the icon you want, click the `Create` button, now you have your first 2FA token: + +token + +Click the number will copy it to clipboard. + +## Show Backup QRcode + +Someone will like to backup their 2FA tokens when everytime they setup a new 2FA token to another 2FA app. + +menu + +Authman provides a function to show QRCode for backup usage, just click the dots on token right-bottom side of token modal, and click `Show QRcode`, Authman will display a QRCode image for this token, you can use another app or device to scan it. + +qrcode + +## Delete Tokens + +To delete one token, you may simply click the dots and select the `Delete` option. + +menu + +To delete multiple tokens, click the `Edit` button on app header, and checked the tokens you want to delete, then click the `Delete` button on app header: + +delete multiple + +## Export Tokens + +If you want to export your tokens for backup usage or transfer to another app, just go to **Options > My Account** and click `Export` option. + +![export](https://github.com/simular/authman-app/assets/1639206/336b4862-9a72-44d2-8040-5408ac44d643) + +Authman will ask your password again and download all decrypted tokens as a JSON file, you can choose a directory to save it. + +## Import Tokens + +If you have an Authman exported JSON file, you can import it to another Authman account, or use it to recover your tokens. + +Go to **Options > My Account** and click `Import` option, then choose the json file. + +![import](https://github.com/simular/authman-app/assets/1639206/11503c25-f798-4257-84a7-62a96689e2c5) + +> [!NOTE] +> Currently, Authman only supports import file which is exported from Authman, we are considering add the way to import from other 2FA apps in the future. + +