From ff4d58b4cef1760b485c2c923509a0443423f6e5 Mon Sep 17 00:00:00 2001 From: Skylar Ittner Date: Sat, 22 Sep 2018 23:18:54 -0600 Subject: [PATCH] Rename to , close #1 --- docs/Guide/Account Security.md | 28 +++++ docs/{User Guide => Guide}/Dashboard.md | 6 +- docs/{User Guide => Guide}/Logging In.md | 4 +- docs/{User Guide => Guide}/Sync Settings.md | 21 ++-- docs/User Guide/Account Security.md | 28 ----- docs/images/docs-icon.svg | 117 -------------------- docs/images/logo.svg | 96 ---------------- docs/index.md | 4 +- mkdocs.yml | 13 ++- 9 files changed, 57 insertions(+), 260 deletions(-) create mode 100644 docs/Guide/Account Security.md rename docs/{User Guide => Guide}/Dashboard.md (88%) rename docs/{User Guide => Guide}/Logging In.md (87%) rename docs/{User Guide => Guide}/Sync Settings.md (68%) delete mode 100644 docs/User Guide/Account Security.md delete mode 100644 docs/images/docs-icon.svg delete mode 100644 docs/images/logo.svg diff --git a/docs/Guide/Account Security.md b/docs/Guide/Account Security.md new file mode 100644 index 0000000..63d6655 --- /dev/null +++ b/docs/Guide/Account Security.md @@ -0,0 +1,28 @@ +# Account Security + +
+ +## Change Password +Card with a text box for the current password, followed by two boxes for the new password.Type your current password and new password where prompted on the screen. You will need to type your new password twice. Press . If your current password is correct, you entered the new password correctly, and your new password meets the security requirements, your password will be updated. + +

+ +## Change PIN + +Card with two text boxes for entering a PIN code, and a button titled 'Change PIN'.For more secure access when logging into the Station kiosk app, you may set a numerical PIN code between 1 and 8 digits in length. Enter the new PIN twice and press . To remove the PIN, leave both boxes empty and press . + +

+ +## Setup 2-factor authentication + +2-factor authentication, or 2FA, is the security practice of using a continually-changing code to make it much harder to hack in to an account. The Business Apps support TOTP, a common 2FA method. With 2FA enabled, you will be asked for a six-digit code in addition to your password. This code will be shown on an app on your phone or other device, and changes every 30 seconds. + +### Enable 2FA +Card with a QR code, text box titled 'Enter 6-digit code', button titled 'Finish Setup', and information for manual setup.To setup TOTP 2-factor authentication, download an app such as Netsyms Business Mobile, andOTP, Authy, or Google Authenticator on your phone. In AccountHub, press , add the barcode with your mobile authenticator app, and press in AccountHub. + +

+ +### Disable 2FA +Card with a button titled 'Disable 2-factor authentication'.To disable 2FA, press from the Account options in AccountHub. If you are unable to log in due to not having a 2FA code, tech support can remove 2FA from your account for you. + +

\ No newline at end of file diff --git a/docs/User Guide/Dashboard.md b/docs/Guide/Dashboard.md similarity index 88% rename from docs/User Guide/Dashboard.md rename to docs/Guide/Dashboard.md index c2b526c..d982964 100644 --- a/docs/User Guide/Dashboard.md +++ b/docs/Guide/Dashboard.md @@ -3,7 +3,7 @@ The dashboard, or home page, is what you will see after logging in. It shows yo ## Navigating between apps -Grid of colored cards, each containing an app icon, app name, and descriptive text +Grid of colored cards, each containing an app icon, app name, and descriptive text Near the top of the dashboard, you will see one or more rows of icons. You can click on these icons to go to other apps. To return to the dashboard from the other apps, click your name in the bar near the top of the screen. @@ -12,11 +12,11 @@ Near the top of the dashboard, you will see one or more rows of icons. You can There are various "cards" on the dashboard. They will take you to the different applications available. You can use them instead of the icons, if you choose. -Grid of colored cards, each containing an app icon, app name, and descriptive text +Grid of colored cards, each containing an app icon, app name, and descriptive text ## Notifications -Sample notification card with title, two buttons (from left to right, a blue eye and a red trash can), some text, and a footer with a date and time +Sample notification card with title, two buttons (from left to right, a blue eye and a red trash can), some text, and a footer with a date and time Certain activity in the Business Apps can cause you to receive notifications. diff --git a/docs/User Guide/Logging In.md b/docs/Guide/Logging In.md similarity index 87% rename from docs/User Guide/Logging In.md rename to docs/Guide/Logging In.md index 47f191e..854c2fc 100644 --- a/docs/User Guide/Logging In.md +++ b/docs/Guide/Logging In.md @@ -1,10 +1,10 @@ # Logging In 1. Go to the address of the AccountHub server in your web browser (Firefox, Chrome, etc.). This address will be supplied by your adminstrator or Netsyms Technologies. -2. Enter your username and password. Login screen, with boxes labeled 'Username' and 'Password', and a button labeled 'Continue' +2. Enter your username and password. Login screen, with boxes labeled 'Username' and 'Password', and a button labeled 'Continue' * Do not enter your email address. * Passwords are case-sensitive. -3. If you have setup a 2-factor authentication app, AccountHub will ask you for a code. Open the app on your phone or other device and type the displayed code.Login screen, with text box for entering authentication code and a button labeled 'Continue' +3. If you have setup a 2-factor authentication app, AccountHub will ask you for a code. Open the app on your phone or other device and type the displayed code.Login screen, with text box for entering authentication code and a button labeled 'Continue' * The code changes every 30 seconds. If you don't submit the code in that time window, it may be considered incorrect and you will have to go back to step 2. The system will also accept the previous code, in case it changed while you were typing. 4. You are now logged in. diff --git a/docs/User Guide/Sync Settings.md b/docs/Guide/Sync Settings.md similarity index 68% rename from docs/User Guide/Sync Settings.md rename to docs/Guide/Sync Settings.md index 5cd7031..fa3f883 100644 --- a/docs/User Guide/Sync Settings.md +++ b/docs/Guide/Sync Settings.md @@ -1,19 +1,26 @@ # Sync Settings -If you wish to access the Business Apps from your smartphone or tablet, you can download Business Apps for Mobile on your device. The first time you open the app, you will be told to scan a sync code.Card with a text box labeled 'Device nickname', a button labeled 'Create new sync code', and a list of paired devices. +## Sync Mobile App +If you wish to access the Business Apps from your smartphone or tablet, you can download Business Apps for Mobile on your device. The first time you open the app, you will be told to scan a sync code.Card with a text box labeled 'Device nickname', a button labeled 'Create new sync code', and a list of paired devices. -## Pairing the Mobile App -To generate a sync code, go to Sync Settings in AccountHub, enter a name in the "Device Nickname" box, and press . Card with a QR code, button titled 'Done adding code', and manual setup information. +### Pairing the Mobile App +To generate a sync code, go to Sync Settings in AccountHub, enter a name in the "Device Nickname" box, and press . Card with a QR code, button titled 'Done adding code', and manual setup information. -Follow the instructions on your smartphone or tablet to scan the code and finish the setup process. If you cannot scan the code for whatever reason, press on your phone and type the details shown below the sync code in AccountHub. Image of phone screen showing mobile app with button labeled 'Scan Code' and button labeled 'Manual Setup'. +Follow the instructions on your smartphone or tablet to scan the code and finish the setup process. If you cannot scan the code for whatever reason, press on your phone and type the details shown below the sync code in AccountHub. Image of phone screen showing mobile app with button labeled 'Scan Code' and button labeled 'Manual Setup'.

-## Unpairing the Mobile App +### Unpairing the Mobile App From Sync Settings in AccountHub, press the red trash can icon next to the sync key. The mobile app will no longer work until it is re-paired with a new key. If you are unpairing because your phone or tablet was lost or stolen, you should also change your password, because the password is stored on the phone or tablet to facilitate automatic login and could be recovered. If your phone or tablet was not lost or stolen, you should open the settings in Business Apps for Mobile and clear all saved data. -## Updating your Password +### Updating your Password -The mobile app saves your password so you don't have to type it every time. If you change your password, you will need to tell the mobile app the new password. Open the app settings, press the button titled , and enter your new password. \ No newline at end of file +The mobile app saves your password so you don't have to type it every time. If you change your password, you will need to tell the mobile app the new password. Open the app settings, press the button titled , and enter your new password. + +## Notifications + +If you have an RSS or ATOM feed reader, you can subscribe to Business Apps notifications through it. Simply add one of the URLs from the Notifications card to your feed reader. + +The URLs you see are unique to your user account and should be kept private. Anyone with the URL can read your notifications. If you suspect someone else might have the URL, press the Reset button, This will change your feed URLs, and the old ones will no longer work. If you do this, be sure to update your feed reader with the new URL. \ No newline at end of file diff --git a/docs/User Guide/Account Security.md b/docs/User Guide/Account Security.md deleted file mode 100644 index 55e93cf..0000000 --- a/docs/User Guide/Account Security.md +++ /dev/null @@ -1,28 +0,0 @@ -# Account Security - - - -## Change Password -Card with a text box for the current password, followed by two boxes for the new password.Type your current password and new password where prompted on the screen. You will need to type your new password twice. Press . If your current password is correct, you entered the new password correctly, and your new password meets the security requirements, your password will be updated. - -

- -## Change PIN - -Card with two text boxes for entering a PIN code, and a button titled 'Change PIN'.For more secure access when logging into the Station kiosk app, you may set a numerical PIN code between 1 and 8 digits in length. Enter the new PIN twice and press . To remove the PIN, leave both boxes empty and press . - -

- -## Setup 2-factor authentication - -2-factor authentication, or 2FA, is the security practice of using a continually-changing code to make it much harder to hack in to an account. The Business Apps support TOTP, a common 2FA method. With 2FA enabled, you will be asked for a six-digit code in addition to your password. This code will be shown on an app on your phone or other device, and changes every 30 seconds. - -### Enable 2FA -Card with a QR code, text box titled 'Enter 6-digit code', button titled 'Finish Setup', and information for manual setup.To setup TOTP 2-factor authentication, download an app such as Netsyms Business Mobile, andOTP, Authy, or Google Authenticator on your phone. In AccountHub, press , add the barcode with your mobile authenticator app, and press in AccountHub. - -

- -### Disable 2FA -Card with a button titled 'Disable 2-factor authentication'.To disable 2FA, press from the Account options in AccountHub. If you are unable to log in due to not having a 2FA code, tech support can remove 2FA from your account for you. - -

\ No newline at end of file diff --git a/docs/images/docs-icon.svg b/docs/images/docs-icon.svg deleted file mode 100644 index 2912202..0000000 --- a/docs/images/docs-icon.svg +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - diff --git a/docs/images/logo.svg b/docs/images/logo.svg deleted file mode 100644 index 6780285..0000000 --- a/docs/images/logo.svg +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - diff --git a/docs/index.md b/docs/index.md index 80adc0a..99c4948 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,6 @@ -# AccountHub - AccountHub is a web application enabling secure self-serve account management. Employees can change their password and manage other web apps they have access to with the dashboard. -## Features +# Features * __2-factor authentication__ * Allows users to setup both a password and an authentication device to add an extra layer of security. diff --git a/mkdocs.yml b/mkdocs.yml index 5425843..2ac3860 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,16 +1,21 @@ site_name: AccountHub Docs theme: name: 'material' - logo: 'images/logo.svg' - favicon: 'images/docs-icon.svg' + logo: 'https://static.netsyms.net/images/products/accounthub/logo.svg' + favicon: 'https://static.netsyms.net/images/netsyms/documentation/docs-icon.svg' + font: false feature: tabs: false palette: primary: 'orange' accent: 'orange' extra_javascript: - - track.js + - 'https://static.netsyms.net/fontawesome/5.3.1/js/all.min.js' + - 'https://docs.netsyms.com/track.js' +extra_css: + - 'https://docs.netsyms.com/font.css' + - 'https://docs.netsyms.com/media.css' site_author: Netsyms Technologies repo_name: 'Business/AccountHub' repo_url: 'https://source.netsyms.com/Business/AccountHub' -copyright: Copyright © 2017-2018 Netsyms Technologies. All rights reserved. Copying is allowed for instructional purposes (such as creating an internal user help document) as long as credit is given and this copyright notice is included. For other purposes, or if you are selling a product containing copied material, please contact us for permission. +copyright:
Creative Commons License
Copyright © 2017-2018 Netsyms Technologies. Some rights reserved.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.