Преглед изворни кода

Add features, system requirements, and login tutorial

master
Skylar Ittner пре 2 година
комит
2138778af2
5 измењених фајлова са 56 додато и 0 уклоњено
  1. 1
    0
      .gitignore
  2. 14
    0
      docs/index.md
  3. 14
    0
      docs/requirements.md
  4. 25
    0
      docs/users.md
  5. 2
    0
      mkdocs.yml

+ 1
- 0
.gitignore Прегледај датотеку

@@ -0,0 +1 @@
1
+site/

+ 14
- 0
docs/index.md Прегледај датотеку

@@ -0,0 +1,14 @@
1
+# Portal
2
+
3
+Portal 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.
4
+
5
+## Features
6
+
7
+* __Active Directory integration__
8
+    * Transparently manages LDAP and local accounts simultaneously.
9
+* __2-factor authentication__
10
+    * Use both a password and a device to add an extra layer of security.
11
+* __Easily-extendable dashboard__
12
+    * Add additional dashboard widgets with as little as five lines of code, for easy access to and overviews of other applications
13
+* __Modern__
14
+    * Portal uses the latest open web technology to provide a seamless, uniform user experience on phones, tablets, desktops, and laptops, from anywhere in the world.

+ 14
- 0
docs/requirements.md Прегледај датотеку

@@ -0,0 +1,14 @@
1
+# System Requirements
2
+
3
+Portal is tested and officially supported on the following configurations.  Other systems may be supported at our discretion, possibly with a support fee.  Portal should work on any sane PHP/SQL based web stack.
4
+
5
+* Server Operating System
6
+    * Ubuntu 16.04
7
+* PHP
8
+    * 7.0
9
+    * 7.1
10
+* Database
11
+    * MySQL 5.7+
12
+    * MariaDB 10.0/10.1
13
+* Web Server
14
+    * Apache 2.4

+ 25
- 0
docs/users.md Прегледај датотеку

@@ -0,0 +1,25 @@
1
+# Logging In
2
+
3
+1. Go to the address of the Portal server in your web browser (Firefox, Chrome, etc.).  This address should be supplied by your IT staff.
4
+2. Enter your username and password.
5
+    * Do not enter your email address.
6
+    * Passwords are case-sensitive.
7
+3. If you have setup a 2-factor authentication app, Portal will ask you for a code.  Open the app on your phone or other device and type the displayed code.
8
+    * The code changes every 30 seconds.  If you don't submit the code in that time window, it will be considered incorrect and you will have to go back to step 2.
9
+4. You are now logged in.
10
+
11
+# Login Troubleshooting
12
+There are some common error messages you may see while logging in.  Here's what they mean annd what you can do about them.
13
+
14
+* __Login incorrect.__
15
+    This means you have entered an incorrect username or password.  Try again.
16
+* __Authentication code incorrect.__
17
+    The 2-factor authentication code you entered was either wrong or expired.  Log in and try again.
18
+* __This account has been disabled. Contact technical support.__
19
+    Your account has been marked as disabled by your IT staff.  Contact them to resolve the issue.
20
+* __Account terminated.  Access denied.__
21
+    The user account has been closed by your IT staff.  Contact them to resolve the issue.
22
+* __Your account state is not stable.  Log out, restart your browser, and try again.__
23
+    Your account is not syncronized between the Portal server and the Active Directory domain controller.  Log out (if you are logged in), close your web browser, and start over.  If you continue to see this error, try clearing your cookies and cache or contact your IT department.
24
+* __You must change your password before continuing.__
25
+    Your password has been marked by IT staff as requiring a reset before you can log in.

+ 2
- 0
mkdocs.yml Прегледај датотеку

@@ -0,0 +1,2 @@
1
+site_name: Portal Docs
2
+theme: 'readthedocs'

Loading…
Откажи
Сачувај