Documentation
/
AccountHub
2
0
Fork 0
Code Issues 2 Pull Requests Releases Activity

Rename to , close #1

Browse Source
master
Skylar Ittner 6 years ago
parent 9fe280d449
commit ff4d58b4ce
9 changed files with 57 additions and 260 deletions
Show Stats Download Patch File Download Diff File

28
docs/Guide/Account Security.md
Unescape Escape View File

@ -0,0 +1,28 @@
# Account Security
<div class="aspect-16x9"><iframe width="560" height="315" sandbox="allow-same-origin allow-scripts" src="https://video.netsyms.com/videos/embed/96f0fd5b-6254-4e66-a165-4b65dffa69c9" frameborder="0" allowfullscreen></iframe></div>
## Change Password
<img src="../../images/screenshots/changepassword.png" alt="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 <button>Change password</button>. 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.
<p style="clear: both;"></p>
## Change PIN
<img src="../../images/screenshots/changepin.png" alt="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 <button>Change PIN</button>. To remove the PIN, leave both boxes empty and press <button>Change PIN</button>.
<p style="clear: both;"></p>
## 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
<img src="../../images/screenshots/setup2fa2.png" alt="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 <button>Enable 2-factor authentication</button>, add the barcode with your mobile authenticator app, and press <button>Finish setup</button> in AccountHub.
<p style="clear: both;"></p>
### Disable 2FA
<img src="../../images/screenshots/disable2fa.png" alt="Card with a button titled 'Disable 2-factor authentication'." />To disable 2FA, press <button>Disable 2-factor authentication</button> 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.
<p style="clear: both;"></p>

6
docs/User Guide/Dashboard.md → docs/Guide/Dashboard.md
Unescape Escape View File

@ -3,7 +3,7 @@ The dashboard, or home page, is what you will see after logging in. It shows yo
## Navigating between apps
<img alt="Grid of colored cards, each containing an app icon, app name, and descriptive text" src="../../images/screenshots/appdock.png" style="float: right; margin-bottom: 10px;">
<img alt="Grid of colored cards, each containing an app icon, app name, and descriptive text" src="../../images/screenshots/appdock.png" class="no-shadow">
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.
<img alt="Grid of colored cards, each containing an app icon, app name, and descriptive text" src="../../images/screenshots/appcards.png" style="float: right; margin-bottom: 10px;">
<img alt="Grid of colored cards, each containing an app icon, app name, and descriptive text" src="../../images/screenshots/appcards.png" class="no-shadow">
## Notifications
<img alt="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" src="../../images/screenshots/notification.png" style="float: right; margin: 10px;">
<img alt="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" src="../../images/screenshots/notification.png" class="no-shadow">
Certain activity in the Business Apps can cause you to receive notifications.

4
docs/User Guide/Logging In.md → docs/Guide/Logging In.md
Unescape Escape View File

@ -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. <img src="../../images/screenshots/login.png" alt="Login screen, with boxes labeled 'Username' and 'Password', and a button labeled 'Continue'" style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />
2. Enter your username and password. <img src="../../images/screenshots/login.png" alt="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.<img src="../../images/screenshots/2falogin2.png" alt="Login screen, with text box for entering authentication code and a button labeled 'Continue'" style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />
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.<img src="../../images/screenshots/2falogin2.png" alt="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.

21
docs/User Guide/Sync Settings.md → docs/Guide/Sync Settings.md
Unescape Escape View File

@ -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.<img src="../../images/screenshots/syncapp1.png" alt="Card with a text box labeled 'Device nickname', a button labeled 'Create new sync code', and a list of paired devices." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />
## 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.<img src="../../images/screenshots/syncapp1.png" alt="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 <button>Create new sync code</button>. <img src="../../images/screenshots/syncapp2.png" alt="Card with a QR code, button titled 'Done adding code', and manual setup information." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />
### 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 <button>Create new sync code</button>. <img src="../../images/screenshots/syncapp2.png" alt="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 <button>Manual Setup</button> on your phone and type the details shown below the sync code in AccountHub. <img src="../../images/screenshots/mobilesync.png" alt="Image of phone screen showing mobile app with button labeled 'Scan Code' and button labeled 'Manual Setup'." style="margin: 10px; float: right; border: 1px solid #555;" />
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 <button>Manual Setup</button> on your phone and type the details shown below the sync code in AccountHub. <img src="../../images/screenshots/mobilesync.png" alt="Image of phone screen showing mobile app with button labeled 'Scan Code' and button labeled 'Manual Setup'." />
<p style="clear:both;"></p>
## 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 <button>Update Password</button>, and enter your new 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 <button>Update Password</button>, 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 <i class="fas fa-sync"></i> 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.

28
docs/User Guide/Account Security.md
Unescape Escape View File

@ -1,28 +0,0 @@
# Account Security
<iframe width="560" height="315" sandbox="allow-same-origin allow-scripts" src="https://video.netsyms.com/videos/embed/96f0fd5b-6254-4e66-a165-4b65dffa69c9" frameborder="0" allowfullscreen></iframe>
## Change Password
<img src="../../images/screenshots/changepassword.png" alt="Card with a text box for the current password, followed by two boxes for the new password." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />Type your current password and new password where prompted on the screen. You will need to type your new password twice. Press <button>Change password</button>. 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.
<p style="clear: both;"></p>
## Change PIN
<img src="../../images/screenshots/changepin.png" alt="Card with two text boxes for entering a PIN code, and a button titled 'Change PIN'." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />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 <button>Change PIN</button>. To remove the PIN, leave both boxes empty and press <button>Change PIN</button>.
<p style="clear: both;"></p>
## 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
<img src="../../images/screenshots/setup2fa2.png" alt="Card with a QR code, text box titled 'Enter 6-digit code', button titled 'Finish Setup', and information for manual setup." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />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 <button>Enable 2-factor authentication</button>, add the barcode with your mobile authenticator app, and press <button>Finish setup</button> in AccountHub.
<p style="clear: both;"></p>
### Disable 2FA
<img src="../../images/screenshots/disable2fa.png" alt="Card with a button titled 'Disable 2-factor authentication'." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />To disable 2FA, press <button>Disable 2-factor authentication</button> 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.
<p style="clear: both;"></p>

117
docs/images/docs-icon.svg
Unescape Escape View File

@ -1,117 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="512"
height="512"
viewBox="0 0 511.99999 511.99999"
id="svg2"
version="1.1"
inkscape:version="0.91 r13725"
sodipodi:docname="docs-icon.svg"
inkscape:export-filename="/home/skylar/Documents/Assets/Graphics/docs-icon.png"
inkscape:export-xdpi="45"
inkscape:export-ydpi="45">
<defs
id="defs4" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="0.98994949"
inkscape:cx="52.220574"
inkscape:cy="225.3771"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false"
units="px"
inkscape:window-width="1920"
inkscape:window-height="1023"
inkscape:window-x="107"
inkscape:window-y="1024"
inkscape:window-maximized="1" />
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(0,-540.36219)">
<rect
y="593.73596"
x="56"
height="50"
width="400"
id="rect4187"
style="fill:#00b0ff;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
<rect
style="fill:#9e9e9e;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4150"
width="380"
height="50"
x="76"
y="683.25037" />
<rect
style="fill:#9e9e9e;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4154"
width="380"
height="50"
x="76"
y="953.25037" />
<g
id="g4162"
style="fill:#bdbdbd">
<rect
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4148"
width="320"
height="50"
x="136"
y="773.25037" />
<circle
r="12.5"
cy="798.25037"
cx="101.19038"
id="path4160"
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
</g>
<g
transform="translate(40,90.000002)"
id="g4162-3"
style="fill:#bdbdbd">
<rect
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4148-6"
width="280"
height="50"
x="136"
y="773.25037" />
<circle
r="12.5"
cy="798.25037"
cx="101.19038"
id="path4160-7"
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
</g>
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 3.7 KiB

96
docs/images/logo.svg
Unescape Escape View File

@ -1,96 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
version="1.1"
id="svg2"
viewBox="0 0 512.00001 512.00001"
height="512"
width="512">
<defs
id="defs4">
<pattern
id="pattern6179"
width="8.6875"
patternUnits="userSpaceOnUse"
patternTransform="translate(201.25 133.47)"
height="8.15625">
<path
id="path6174"
style="opacity:.32394;stroke-opacity:0;fill:#eeeeec"
d="m1.9375 0.5c-0.8781 0.7454-1.4375 1.8526-1.4375 3.0938 0 2.2424 1.82 4.0624 4.0625 4.0624 1.5819 0 2.9541-0.9292 3.625-2.25-0.7084 0.6014-1.6237 1-2.625 1-2.2425 0-4.0625-1.82-4.0625-4.0624 0-0.6607 0.1573-1.2922 0.4375-1.8438z" />
</pattern>
</defs>
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
transform="translate(0,-540.36216)"
id="layer1">
<rect
ry="50"
rx="50"
y="540.36218"
x="0"
height="512"
width="512"
id="rect4726"
style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:20;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804" />
<rect
style="fill:#4caf50;fill-opacity:1;stroke:#4caf50;stroke-opacity:1;stroke-width:25.00000004;stroke-miterlimit:4;stroke-dasharray:none"
id="rect4144"
width="543.95947"
height="15"
x="472.15271"
y="374.59375"
rx="10"
ry="10"
transform="matrix(0.70710678,0.70710678,-0.70710678,0.70710678,0,0)" />
<rect
transform="matrix(0.70710678,0.70710678,-0.70710678,0.70710678,0,0)"
ry="10"
rx="10"
y="373.31586"
x="471.13791"
height="17.555813"
width="257.55582"
id="rect4211"
style="fill:#2196f3;fill-opacity:1;stroke:#2196f3;stroke-width:25;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
<rect
transform="matrix(-0.70710678,0.70710678,-0.70710678,-0.70710678,0,0)"
ry="10"
rx="10"
y="-751.63245"
x="110.11401"
height="15"
width="543.95947"
id="rect4142"
style="fill:#795548;fill-opacity:1;stroke:#ff5722;stroke-opacity:1;stroke-width:25.00000004;stroke-miterlimit:4;stroke-dasharray:none" />
<rect
style="fill:#607d8b;fill-opacity:1;stroke:#607d8b;stroke-width:25;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
id="rect4241"
width="257.55582"
height="17.555811"
x="395.76828"
y="-752.91034"
rx="10"
ry="10"
transform="matrix(-0.70710678,0.70710678,-0.70710678,-0.70710678,0,0)" />
<path
d="m 314.83612,724.61503 c 0,-32.47491 -26.37082,-58.81687 -58.85538,-58.81687 -32.4749,0 -58.81686,26.34196 -58.81686,58.81687 0,23.22249 13.21911,41.18817 33.03334,52.86683 0,0 -9.14651,34.98779 -6.76841,36.13351 l 13.11319,6.33516 -1.22274,5.59381 14.34557,12.40074 -1.95445,11.66902 -1.47308,2.38771 0.21183,4.51549 4.19775,5.72861 -0.97241,9.72418 -8.19336,8.56884 2.87876,12.7377 4.82359,24.40674 12.39109,9.2428 17.27247,-8.28001 0.36585,-109.54627 c 0,0 7.89489,1.04943 10.83139,-0.35625 3.14834,-1.5212 -9.4546,-30.66486 -9.4546,-30.66486 20.19935,-9.3198 34.24646,-29.76947 34.24646,-53.46375 z M 273.9753,704.93559 c 0,9.53162 -8.00081,17.24357 -17.8694,17.24357 -9.87822,0 -17.90789,-7.71195 -17.90789,-17.24357 0,-9.52199 8.02967,-17.26282 17.90789,-17.26282 9.86859,0 17.8694,7.74082 17.8694,17.26282 z"
style="fill:#ff9800;fill-opacity:1;stroke:#ffffff;stroke-width:4.8;stroke-miterlimit:4;stroke-dasharray:none"
id="path4516" />
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 4.0 KiB

4
docs/index.md
Unescape Escape View File

@ -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.

13
mkdocs.yml
Unescape Escape View File

@ -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 &copy; 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 <a href="https://netsyms.com/contact" target="_BLANK">contact us</a> for permission.
copyright: <br /><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://docs.netsyms.com/cc-by-sa88x31.png" /></a><br />Copyright &copy; 2017-2018 Netsyms Technologies. Some rights reserved.<br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.

Write Preview
Loading…
Cancel
Save