Adds Documentation for the Teams Version

resources/docs/teams/admin/automation-settings.md

@@ -0,0 +1,37 @@
+# Automation Settings - Teams Version
+
+Admin Automation Settings page of `LaraPass v2 Teams Version`
+
+---
+
+- [Overview](#overview)
+- [Scheduled Tasks](#task)
+- [Optimization](#optimize)
+- [<a href="https://github.com/larapass/docs/edit/master/resources/docs/teams/admin/automation-settings.md" target="_blank"><i class="fa fa-edit"></i> Help us improve this page!</a>](#)
+
+<a name="overview"></a>
+## Overview
+
+This area manages any automated tasks that `larapass` performs behind-the-scenes.
+
+---
+
+<a name="tasks"></a>
+## Scheduled Tasks
+
+LaraPass v2 has certain tasks that it performs (on repeat) at regular intervals. Some of these tasks include - clearing old logs, delete accounts that have been marked for deletion and have passed their grace period, taking backups, etc.  
+<br>
+
+![screenshot](/screenshots/admin/automation/overview.png)
+
+---
+
+<a name="optmize"></a>
+## Optimization
+
+From time-to-time, you can utilize Laravel's build-in optimization system to speed up your app (useful when you have 100's or 1000's of daily views/sessions). 
+
+---
+<br />
+<larecipe-feedback message="Thankyou for your feedback!">
+</larecipe-feedback>

resources/docs/teams/admin/email-settings.md

@@ -0,0 +1,66 @@
+# Email Settings (Transactional Emails) - Teams Version
+
+Admin Email Settings page of `LaraPass v2 Teams Version`
+
+---
+
+- [Overview](#overview)
+- [Recommended Mailers](#recommended)
+- [Configuration](#configuration)
+- [Send Test Mail](#test)
+- [<a href="https://github.com/larapass/docs/edit/master/resources/docs/teams/admin/email-settings.md" target="_blank"><i class="fa fa-edit"></i> Help us improve this page!</a>](#)
+
+<a name="overview"></a>
+## Overview
+
+You can update your mailer for sending notifications and update emails from here.
+
+![screenshot](/screenshots/admin/settings/email-1.png)
+
+---
+
+<a name="recommended"></a>
+## Recommended Mailers
+
+We recommend the following mailing services as best for sending transactional emails. However, you are free to use any 3rd-Party service that allows outgoing SMTP services (ex: Gmail, etc).
+
+<p float="left">
+  <a href="https://refs.spargon.tech/mailgun"><img src="/brands/mg_logo.png" width="180" alt="mailgun"/></a> &nbsp;
+  <a href="https://refs.spargon.tech/elastic-email"><img src="/brands/ee_logo.png" width="180" alt="elastic-email"/></a> &nbsp;
+  <a href="https://refs.spargon.tech/send-grid"><img src="/brands/sg_logo.png" width="180" alt="send-grind"/></a> &nbsp;
+  <a href="https://refs.spargon.tech/send-in-blue"><img src="/brands/sib_logo.png" width="180" alt="send-in-blue"/></a>
+</p>
+---
+
+<a name="configuration"></a>
+## Configuration
+
+LaraPass mailer offers 3 types of mail drivers for sending outgoing emails - 
++ **`Log`** (all emails/notifications sent are logged into the laravel.log file in the local storage) - Only use this for testing.
++ **`SMTP`** (use any 3rd party service that provides smtp for outgoing emails and add credentials for that here).
++ **`Mailgun API`** (setup mailgun and get their API & Secret Key and add it here).  
+<br/>
+
+After selecting the **`Mail Driver`**, configure the mailer accordingly - 
+
++ Enter the **Mail Host Address** you get from your mailing service provider (only when using the SMTP Driver).
++ Enter the **Mail Port** - usually 587 (only when using the SMTP Driver).
++ Select **Mail Encryption** - usually START/TLS (only when using the SMTP Driver).
++ Enter the **Mail Username** - your smtp login username (only when using the SMTP Driver).
++ Enter the **Mail Password** - your smtp login password (only when using the SMTP Driver).
++ Enter the **Mail From Address** - The `sent from email` to be shown in the emails (required for all drivers).
++ Enter the **Mail From Name** - The `sent from name` to be shown in the emails (required for all drivers).
++ Enter the **Mailgun Domain** - your mailgun domain (only when using the Mailgun API Driver).
++ Enter the **Mailgun Secret Key** - your mailgun secret key (only when using the Mailgun API Driver).
+
+---
+
+<a name="test"></a>
+## Send Test Mail
+
+After configuring the mailer, click on the **`Send Test Mail`** button to test and verify whether the email is being sent and received as expected or not. The *test* email will be sent to the email address stored as `App Email` in the [**General Settings**](general-settings).
+
+---
+<br />
+<larecipe-feedback message="Thankyou for your feedback!">
+</larecipe-feedback>  

resources/docs/teams/admin/general-settings.md

@@ -0,0 +1,68 @@
+# General Settings - Teams Version
+
+Admin General Settings page of `LaraPass v2 Teams Version`
+
+---
+
+- [Overview](#overview)
+- [App Logo](#logo)
+- [Themes](#theme)
+- [Language / Locale](#locale)
+- [Footer Copyright](#copyright)
+- [Force HTTPS](#force-https)
+- [<a href="https://github.com/larapass/docs/edit/master/resources/docs/teams/admin/general-settings.md" target="_blank"><i class="fa fa-edit"></i> Help us improve this page!</a>](#)
+
+<a name="overview"></a>
+## Overview
+
+You can update basic information about your app like name, description, logo, favicon, copyright text, locale, etc from here.
+
+![screenshot](/screenshots/admin/settings/general-1.png)
+
+---
+
+<a name="logo"></a>
+## App Logo
+
+You can upload your App Logo & favicon from here. Be sure to upload a darker and lighter version of your logo.
+
+---
+
+<a name="theme"></a>
+## Themes
+
+You can select from any of the available themes here. The theme will be applied site wide. 
+
+`Currently we only have a default theme available. More themes will be added soon.`
+
+---
+
+<a name="locale"></a>
+## Language & Locale
+
+You can select a default locale / language from which will be applied site wide to all your users / visitors.  
+<br/>
+If you don't find your desired language in the list and would like to help us expedite the transaltions for it, head over to our [**Translations**](https://github.com/LaraPass/Translations) repo and open a PR for it. All contributions will be credited appropriately.  
+<br/>
+You can also enable `Allow User Locale` which will give your users the ability to switch between different locales regardless of your app's default locale.
+
+---
+
+<a name="copyright"></a>
+## Footer Copyright
+
+You can display whatever copyright text you want to. The field accepts basic HTML styling and tooling - as such you can also add links in the footer using the `<a href="">` tag.
+
+---
+
+<a name="force-https"></a>
+## Force HTTPS
+
+You can **`Enable`** App Level HTTPS Redirection by setting the **Force HTTPS** option to **Yes**. This will redirect all unsecured http urls to secured https urls.
+
+> {warning} We highly recommend using your web servers (Apache / NGINX) config file or the .htaccess file to setup and enable force https redirection instead of using this app-level redirection.
+
+---
+<br />
+<larecipe-feedback message="Thankyou for your feedback!">
+</larecipe-feedback>  

resources/docs/teams/admin/larapass-settings.md

@@ -0,0 +1,63 @@
+# LaraPass Settings - Teams Version
+
+Admin LaraPass Settings page of `LaraPass v2 Teams Version`
+
+---
+
+- [License Verification](#verification)
+- [Auto Updater](#updating)
+- [Watch Demo Video](#video)
+- [<a href="https://github.com/larapass/docs/edit/master/resources/docs/teams/admin/larapass-settings.md" target="_blank"><i class="fa fa-edit"></i> Help us improve this page!</a>](#)
+
+<a name="verification"></a>
+## License Verification
+
+If the app is unable to verify your **`LaraPass v2 Teams Version License`** (most likely due to the license file being deleted or inaccessible) for some reason, you will be asked to re-enter your LaraPass v2 License / Purchase code and Username/Email. Once your license key is verified, you will be able to use the auto-updater.  
+<br/>  
+
+![screenshot](/screenshots/admin/larapass/verification.png)
+
+> {primary} Using auto-updater requires an active `LaraPass v2 Teams Version` license. If you have refunded or cancelled your license, you won't be able to use the auto-updater.
+
+---
+
+<a name="updating"></a>
+## Auto Updater
+
+The auto-updater provides larapass v2 owners with an easy to use, one-click update system. This allows you to keep your **`LaraPass v2`** app up-to-date without any hassle. Just click on the **`Check Update`** button on the **LaraPass Settings** page and it will check and inform you if an update is available. If your app is running on the latest version -  
+<br/>  
+
+<img src="/screenshots/admin/larapass/up-to-date.png" alt="app_up_to_date" width="800px">
+
+<br/>
+If there is an update available for your app, a new **`Update`** page will open that will provide you with the details like: available **version**, **release date**, **changelog**, etc.  
+<br/>  
+
+![screenshot](/screenshots/admin/larapass/update-available.png)
+
+<br/>
+Click on **`Start Update`** to initiate the update process. Once the update is completed, you will recevie a message and can now check your app version is updated as well.
+
+<p>
+    <img src="/screenshots/admin/larapass/updating.png" alt="updating" width="500px">
+    <img src="/screenshots/admin/larapass/update-success.png" alt="update_success" width="500px">
+</p>
+
+> {warning} Be advised - we recommend activating the `Maintenance Mode` before initiating the `Update Process` (so that other users of your app may not encounter any errors during the update process) and taking database backups (offsite) whenever updating to a `Major Version`
+
+---
+
+<a name="video"></a>
+## Watch Demo Video
+
+Watch the demo of how easy it is to update a LaraPass v2 app to the latest version using the in-build auto-updater
+<br>
+
+<a href="https://youtu.be/4-N7wD078BM" target="_blank">
+    <img src="/screenshots/admin/larapass/auto-updater-demo.jpg" alt="Auto-Updater-Demo-Video" width="240" height="180" border="10" />
+</a>
+
+---
+<br />
+<larecipe-feedback message="Thankyou for your feedback!">
+</larecipe-feedback> 

resources/docs/teams/admin/modules-manager.md

@@ -0,0 +1,89 @@
+# Modules Manager - Teams Version
+
+Admin Modules Management page of `LaraPass v2 Teams Version`
+
+---
+
+- [Overview](#overview)
+- [Teams Module](#teams)
+- [Two Factor Auth](#two-factor)
+- [Social Logins](#social)
+- [Google reCaptcha](#recaptcha)
+- [<a href="https://github.com/larapass/docs/edit/master/resources/docs/teams/admin/modules-manager.md" target="_blank"><i class="fa fa-edit"></i> Help us improve this page!</a>](#)
+
+<a name="overview"></a>
+## Overview
+
+You can manage your app's modules including Two Factor Authentication, Social Logins, and Google reCaptch from this page. We are building several other modules including first-party services to integrate with LaraPass v2 which will be released in due time.  
+<br/>  
+
+![screenshot](/screenshots/admin/modules-manager/teams-overview.png)  
+
+---
+
+<a name="teams"></a>
+## Teams Module
+
+This module enables the **`Teams`** functionality of the app. This module is **`Disabled`** by default. You can configure and enable it according to your requirement. You can also **disable** this module in the future and all teams data and access with be closed off aswell (data will always be preserved).
+
+**You can configure the following options in the Teams Module:**
+
++ **Allow Team by Default** - This configurations decides whether or not a new user should automatically be allowed to create new teams (configurable on per user basis aswell).
++ **Default Membership Name** - Name of the Plan / Membership to display on the teams page (doesn't have any effect of the functionality of the module).
++ **Default Member Role** - Which role should be assigned by default to all newly invited members:
+    + Admin - This role have no restrictions and allows users to modify any aspect of the team (not recommended for new invites).
+    + Member - This role gives the user unrestricted access to the Teams Vault and the data within it, but doesnt allow them to modify any aspect of the team itself (inviting members, changing roles, removing members, team logs, etc).
+    + Intern - This role gives the user a read-only acceess, meaning they can access the team's vaults, sites, etc but cannit update or delete any content within the vault (ideal for new invites).
++ **Max. Teams** - This limits the no. of teams a user can create or join (configurable on per user basis from the User Management Menu).
++ **Max. Members** - This limits the no. of members a team can have (configurable on per team basis from the Team Management Menu).
++ **Max. Vaults** - This limits the no. of vaults a team can have (configurable on per team basis from the Team Management Menu).
++ **Max. Sites** - This limits the no. of sites a team can have (configurable on per team basis from the Team Management Menu).
++ **Max. Folders** - This limits the no. of folders a team can have (configurable on per team basis from the Team Management Menu).
++ **Max. Notes** - This limits the no. of notes or custom fields a team can have (configurable on per team basis from the Team Management Menu).
++ **Apply to Existing Teams - Selecting NO will only affect new teams created thereafter, however, selecting YES will overwrite all the teams related limits in the database. If you have made any manual changes to any individual teams limit, they will be overwritten.**
+<br/><br/>
+
+![screenshot](/screenshots/admin/modules-manager/teams-limits.png)  
+
+---
+
+<a name="two-factor"></a>
+## Two Factor Authentication Module
+
+This module is **`Enabled`** by default and allows the users' of your app to setup, activate and use Two Factory Authentication using their Authenticator (TOTP) apps like Google Authenticator, Authy, etc.
+<br/>  
+You can disable this module anytime you like. Disabling it will remove the option to confirm Two Factor Code for the users regardless of whether they had activated it previously or not. This will be applicable site-wide to all the users. 
+<br/>  
+You can also configure whether or not to show the Provider Key to the users' (default is `show`). This allows users to add the TFA Access to their apps without having to scan the QR code (by entering the provider key) - ideally for users' mainly on mobile devices (since they can't scan the QR code). Disabling it will hide the Key from users.
+
+> {warning} For security reasons, we recommend to always keep this module active and never turn it off.
+
+---
+
+<a name="social"></a>
+## Social Logins Module
+
+This module is **`Disabled`** by default as it requires additional configuration. You can enable it by following the steps below. 
+
+> {primary} Instructions on how to get the Client ID / Secret Key for Github, Facebook & Twitter are available [`here`](../misc/social-logins)
+
+Add the client id and secret key for social logins using OAuth here - 
+
++ Select Enable for Github / Facebook / Twitter.
++ Add Client ID & Secret Key respectively.
++ Update Settings.
+
+<img src="/screenshots/admin/settings/system-social-1.png" width="700" alt="system-social-settings"/></a>   
+
+> {warning} Social Logins are only available / visible to users when the app is set to **`PUBLIC`** mode.  
+
++ Login page when all the social logins are enabled -
+
+<img src="/screenshots/admin/settings/system-social-2.png" width="700" alt="system-social-login"/></a> 
+
+> {danger} Beaware - if you `disable` this module, any users that registered on your app via OAuth (Github, FB, Twitter), will no longer be able to login.
+
+---
+<br />
+<larecipe-feedback message="Thankyou for your feedback!">
+</larecipe-feedback>

resources/docs/teams/admin/overview.md

@@ -0,0 +1,34 @@
+# Overview - Teams Version
+
+Admin Overview / Dashboard page of `LaraPass v2 Teams Version` on your server.
+
+---
+
+- [Overview](#overview)
+- [Announcements](#announcements)
+- [<a href="https://github.com/larapass/docs/edit/master/resources/docs/teams/admin/overview.md" target="_blank"><i class="fa fa-edit"></i> Help us improve this page!</a>](#)
+
+<a name="overview"></a>
+## Overview
+
+Get quick stats of your app such as `Total Users`, `Users Registered Today`, `Total Vaults` , `Total Vaults` `Total Sites`, `Total Folders`, `Total Sites` & `Total Notes / CF` created by the users.  
+<br/>
+![screenshot](/screenshots/admin/overview/teams-overview.png)  
+
+> {primary} We are working on making the overview page more informative and as we develop along we will be adding many more detailed statistics and at-a-glance functions for the overview page.
+
+---
+
+<a name="announcements"></a>
+## Announcements
+
+Make site-wide announcements that will be issued to the user. Most recent announcement will be shown on the user's dashboard page. Users' will be able to view all previous announcements as well.  
+
+<p>  
+    <img src="/screenshots/admin/overview/announcement-1.png" width="400" alt="announcement-1"/></a>
+    <img src="/screenshots/admin/overview/announcement-2.png" width="400" alt="announcement-2"/></a> 
+</p>
+---
+<br />
+<larecipe-feedback message="Thankyou for your feedback!">
+</larecipe-feedback>