diff --git a/public/screenshots/admin/modules-manager/teams-limits.png b/public/screenshots/admin/modules-manager/teams-limits.png new file mode 100644 index 0000000..2305141 Binary files /dev/null and b/public/screenshots/admin/modules-manager/teams-limits.png differ diff --git a/public/screenshots/admin/modules-manager/teams-overview.png b/public/screenshots/admin/modules-manager/teams-overview.png new file mode 100644 index 0000000..a1987db Binary files /dev/null and b/public/screenshots/admin/modules-manager/teams-overview.png differ diff --git a/public/screenshots/admin/overview/teams-overview.png b/public/screenshots/admin/overview/teams-overview.png new file mode 100644 index 0000000..043ed81 Binary files /dev/null and b/public/screenshots/admin/overview/teams-overview.png differ diff --git a/public/screenshots/admin/user-management/teams-profile.png b/public/screenshots/admin/user-management/teams-profile.png new file mode 100644 index 0000000..65fae9f Binary files /dev/null and b/public/screenshots/admin/user-management/teams-profile.png differ diff --git a/public/screenshots/installation/installer-3.png b/public/screenshots/installation/installer-3.png index 204ef0a..f137a2b 100644 Binary files a/public/screenshots/installation/installer-3.png and b/public/screenshots/installation/installer-3.png differ diff --git a/public/screenshots/installation/installer-4.png b/public/screenshots/installation/installer-4.png index 9abe30a..204ef0a 100644 Binary files a/public/screenshots/installation/installer-4.png and b/public/screenshots/installation/installer-4.png differ diff --git a/public/screenshots/installation/installer-5.png b/public/screenshots/installation/installer-5.png index 7977284..9abe30a 100644 Binary files a/public/screenshots/installation/installer-5.png and b/public/screenshots/installation/installer-5.png differ diff --git a/public/screenshots/installation/installer-6.png b/public/screenshots/installation/installer-6.png index 30eeefc..7977284 100644 Binary files a/public/screenshots/installation/installer-6.png and b/public/screenshots/installation/installer-6.png differ diff --git a/public/screenshots/installation/installer-7.png b/public/screenshots/installation/installer-7.png index 79c212d..30eeefc 100644 Binary files a/public/screenshots/installation/installer-7.png and b/public/screenshots/installation/installer-7.png differ diff --git a/public/screenshots/installation/installer-8.png b/public/screenshots/installation/installer-8.png new file mode 100644 index 0000000..79c212d Binary files /dev/null and b/public/screenshots/installation/installer-8.png differ diff --git a/resources/docs/teams/admin/automation-settings.md b/resources/docs/teams/admin/automation-settings.md new file mode 100644 index 0000000..ee061b8 --- /dev/null +++ b/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) +- [ Help us improve this page!](#) + + +## Overview + +This area manages any automated tasks that `larapass` performs behind-the-scenes. + +--- + + +## 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. +
+ +![screenshot](/screenshots/admin/automation/overview.png) + +--- + + +## 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). + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/admin/email-settings.md b/resources/docs/teams/admin/email-settings.md new file mode 100644 index 0000000..f977ae9 --- /dev/null +++ b/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) +- [ Help us improve this page!](#) + + +## Overview + +You can update your mailer for sending notifications and update emails from here. + +![screenshot](/screenshots/admin/settings/email-1.png) + +--- + + +## 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). + +

+ mailgun   + elastic-email   + send-grind   + send-in-blue +

+--- + + +## 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). +
+ +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). + +--- + + +## 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). + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/admin/general-settings.md b/resources/docs/teams/admin/general-settings.md new file mode 100644 index 0000000..ae99020 --- /dev/null +++ b/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) +- [ Help us improve this page!](#) + + +## 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) + +--- + + +## App Logo + +You can upload your App Logo & favicon from here. Be sure to upload a darker and lighter version of your logo. + +--- + + +## 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.` + +--- + + +## Language & Locale + +You can select a default locale / language from which will be applied site wide to all your users / visitors. +
+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. +
+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. + +--- + + +## 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 `` tag. + +--- + + +## 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. + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/admin/larapass-settings.md b/resources/docs/teams/admin/larapass-settings.md new file mode 100644 index 0000000..0dc4e86 --- /dev/null +++ b/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) +- [ Help us improve this page!](#) + + +## 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. +
+ +![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. + +--- + + +## 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 - +
+ +app_up_to_date + +
+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. +
+ +![screenshot](/screenshots/admin/larapass/update-available.png) + +
+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. + +

+ updating + update_success +

+ +> {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` + +--- + + +## 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 +
+ + + Auto-Updater-Demo-Video + + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/admin/modules-manager.md b/resources/docs/teams/admin/modules-manager.md new file mode 100644 index 0000000..9804a7d --- /dev/null +++ b/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) +- [ Help us improve this page!](#) + + +## 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. +
+ +![screenshot](/screenshots/admin/modules-manager/teams-overview.png) + +--- + + +## 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.** +

+ +![screenshot](/screenshots/admin/modules-manager/teams-limits.png) + +--- + + +## 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. +
+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. +
+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. + +--- + + +## 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. + +system-social-settings + +> {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 - + +system-social-login + +> {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. + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/admin/overview.md b/resources/docs/teams/admin/overview.md new file mode 100644 index 0000000..3d009b1 --- /dev/null +++ b/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) +- [ Help us improve this page!](#) + + +## 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. +
+![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. + +--- + + +## 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. + +

+ announcement-1 + announcement-2 +

+--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/admin/pages-manager.md b/resources/docs/teams/admin/pages-manager.md new file mode 100644 index 0000000..dedbb8d --- /dev/null +++ b/resources/docs/teams/admin/pages-manager.md @@ -0,0 +1,51 @@ +# Pages Manager - Teams Version + +Overview of Admin Pages Manager build in `LaraPass v2 Teams Version` + +--- + +- [Overview](#overview) +- [Add New Page](#add-page) +- [Edit Page](#edit-pagel) +- [Publish Page](#publish-page) +- [ Help us improve this page!](#) + + +## Overview + +The build-in pages manager makes it super easy to add and edit custom static pages for your app. +
+ +![screenshot](/screenshots/admin/pages-manager/overview.png) + +--- + + +## Add New Page + +Click on **Add New Page** to get started. ++ Enter a Page Title. ++ Enter a unique slug (for url identification). ++ Enter the Body of the page using the WYSIWYG editor. ++ Select Date & Status (Pages marked as *Draft* are only visible to Admins). ++ Click on **Add New Page**. + +![screenshot](/screenshots/admin/pages-manager/add-page.png) +--- + + +## Edit Page + +To `Edit` an existing page, just click on the **Edit** button under the page title and you will be able to modify the content of the page as desired. You can also permanantly `delete` a page by clicking on the **Delete** button under the page title. + +--- + + +## Publish Page + +If you are not yet ready to publish a page (still writing content of it), then you can set the status of your page to **`Draft`**. Pages in draft status will only be visible to admins, regular users or visitors will get a 404-page not found error on accessing it. Once you are satisfied with the content, you can change the status to **`Published`** by editing the page. Once published, the page will be visible to all. + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/admin/system-settings.md b/resources/docs/teams/admin/system-settings.md new file mode 100644 index 0000000..4f697b7 --- /dev/null +++ b/resources/docs/teams/admin/system-settings.md @@ -0,0 +1,67 @@ +# System Settings - Teams Version + +Admin System Settings page of `LaraPass v2 Teams Version` + +--- + +- [Overview](#overview) +- [Maintenance Mode](#maintenance) +- [Application Settings](#app-settings) +- [Access Settings](#access) +- [ Help us improve this page!](#) + + +## Overview + +You can manage your app's system settings including Maintenance Mode, Application, Social Login, Google reCaptcha and Access Settings from this page. +
+ +![screenshot](/screenshots/admin/settings/system-1.png) + +--- + + +## Maintenance Mode + +LaraPass has a build-in maintenace mode that you can activate while performing any backups, maintenance or scheduled downtime. + +You can display a **`custom`** maintenace message to the user (the input accepts basic html styling). + +Once the maintenance mode is active, you can access the app using the **`secret`** url. By default it a random string but you can custom the url accordingly - ex: **`http://yourapp.com/secretaccess`** +
+ +

+ system-maintenance-1 + system-maintenance-2 + system-maintenance-3 +

+
+ +If you somehow forget the secret url or are unable to access the site during the maintenance period, you can manually disable the **`maintenance mode`** in 2 ways - + + If you have access to **console**, navigate to the larapass directory and run the command **`php artisan up`** + + If you do not have access to **console**, open the `larapass/storage/framework` directory and delete the file titled **`down`** + +### You can checkout our demo video of our build-in maintenance mode in action below: + + Installation-Demo-Video + + +--- + + +## Application Settings + +Set your app's default vault configuration/limitations here - ++ Set the default membership name. ++ Set the no. of vaults each user can create. ++ Set the no. of folders each user can create. ++ Set the no. of sites each user can add. ++ Set the no. of notes each user can add. ++ Set whether the system should send users `email` notifications when they reach their account limits or not. + +system-app-settings + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/admin/user-management.md b/resources/docs/teams/admin/user-management.md new file mode 100644 index 0000000..3a4861e --- /dev/null +++ b/resources/docs/teams/admin/user-management.md @@ -0,0 +1,96 @@ +# User Management - Teams Version + +Overview of Admin User Management System build in `LaraPass v2 Teams Version` + +--- + +- [Overview](#overview) +- [User Profile](#user-profile) +- [Manage Plan / Limits](#manage-limits) +- [Change Email](#change-email) +- [View IP Logs](#view-ip-logs) +- [Ban User](#ban-user) +- [ Help us improve this page!](#) + + +## Overview + +Quick overview list of all the registered users of your app. + +![screenshot](/screenshots/admin/user-management/overview.png) + +--- + + +## User Profile + +View the user account information and their stats (vaults, sites, etc owned). Also perform a variety of actions such as - changing email address (will require email verification by user), viewing IP logs, verifying support pin and banning user account. +
+ +![screenshot](/screenshots/admin/user-management/teams-profile.png) + +--- + + +## Manage User Plan / Limits + +You can either manage User Plan & Limits globally through the Admin Settings page [`here`](/teams/admin/system-settings#app-settings) or update limits assigned to each user individually from the User's Profile page. + +**Available Options are:** ++ Allowing Users to Create New Teams. ++ Maximum no. of Teams a user can create. ++ Maximum no. of vaults a user can create. ++ Maximum no. of folders a user can create (in total). ++ Maximum no. of sites a user can add (in total), and ++ Maximum no. of notes/custom fields a user can add (in total). + +--- + + +## Change User Email + +You can change a user's email address on request by the user themselves. You will need to provide the current email address (on the account), the new email address (to be updated to) and the user's Support PIN. Without the Support PIN from the user (inaccessible to admin's themselves), the email address on the user's account cannot be changed. This has been done to ensure users' that admin wont be able to modify their access without authorization. +
+ + + +Once the email address is updated, the system wil send a new verification email to the new email address. The user won't be able to access their account until they verify their email address. + +--- + + +## View IP Logs + +You can view the IP address, device, platform and browser used by a user whenever they login into your app. The same data is also available to the user themselves so they can monitor any authorize or irregular access of their account. +
+ + + +--- + + +## Ban / Un-Ban User + +You can ban any user account by providing a reason. Once an account is banned, the user will receive an email stating when their account was banned, the reason for it and a way to appeal if they feel the ban was unwarranted. +
+ +

+ ban-option + ban-email + ban-screen +

+ +You can also un-ban or revoke ban on an account and the users will be informed of the same. +
+ +

+ banned-user + unban-option + unban-email +

+ + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/basic-setup.md b/resources/docs/teams/basic-setup.md new file mode 100644 index 0000000..c65f597 --- /dev/null +++ b/resources/docs/teams/basic-setup.md @@ -0,0 +1,97 @@ +# Basic Setup - Teams Version + +Basic Setup required for installing `LaraPass v2 Teams Version` on your server. + +--- + +- [Requirements](#requirements) +- [Hosting & Host Manager](#hosting) +- [Digital Ocean Setup](#do) +- [ Help us improve this page!](#) + +> {primary} The Basic Setup and Installation Steps for Teams and Personal Versions are identical. If you have experience installing the Personal Version, the experience with the Teams Version will be no different. + + +## Requirements + +```php +PHP >= 7.4 +Following PHP Extensions: + - BCMath + - Ctype + - Fileinfo + - JSON + - Mbstring + - OpenSSL + - PDO + - Tokenizer + - XML + - Zip Module +NGINX or Apache +MySQL or MariaDB +SSH Access (Recommended) +``` +> {success} You can download the LaraPass v2 Compatibility Tester from [`here`](https://github.com/LaraPass/CompatibilityTester) and confirm whether your server supports it or not. + +--- + + +## Hosting & Host Manager + +> {primary} **LaraPass** works best on a `VPS` with SSH Access. + +Below are some of the reputable and amazingly cheap VPS Providers - + +** +Digital Ocean, Vultr, Amazon AWS +** + +Since these VPS provide raw server with resources, we will need a server manager to run our PHP applications such as LaraPass. Some of the suggested are - + +** +Ploi, RunCloud, ServerPilot, Laravel Forge, Cloudways +** + +All of these service have slightly different pricing and features, so you can check them out and decide for your self. we personally would recommend the combination of **Digital Ocean** & **Ploi** to get the most out of your investment. + +We also recommend downloading & installing **`Bitvise SSH Client`** or any other of your choice so you can connect to your server easily. + +> {warning} *While it does work, we do not recommend running **LaraPass v2** using Shared Hosting as Shared servers are not Secure and may create issues down the line (especially with respect to permissions).* + +If you are still interested in using the cheaper Shared Hosting services, we recommend using **`A2Hosting`** and use coupon code **``SOFAST!``** for 51% Off. + +[![img](https://affiliates.a2hosting.com/accounts/default1/banners/b33b2977.png)](https://www.a2hosting.com?aid=larapass&bid=b33b2977) + +> {success} Visit the [``cPanel Installation Guide Page``](setup/cpanel) for details on how to successfully install **LaraPass v2** on cPanel powered server. + +--- + + +## Digital Ocean Setup + + Setting up a VPS server provided by **`Digital Ocean`** or any other from the above list is very simple and straight forward. These steps are general and are not specific to **LaraPass**. If you already know how to provision a DO server, then just skip this section. If you are using **`Cloudways`**, then you don't need to register at DO, they will handle everything (albeit at an extra premium). + + **Step # 1 -** Visit **`Digital Ocean`** + **Step # 2 -** Create an account. Use coupon/promo code **`DO10`** to get Free Credit to Launch your first server. + **Step # 3 -** Go to **`Create Droplets`**. Select Distritutions/OS as **`Ubuntu 20.04 (LTS) x64`**. + **Step # 4 -** Select any size as per your budget, larapass works fine even with the **`$5/mo - 1GB Droplet Size`** & Select a **`region`** as per your desire. + **Step # 5 -** Choose a **`Hostname`** and Click **`Create`** and wait for the server to get provisioned. + **Step # 6 -** Once the server is provisioned, you will get an Email with the Server IP & the root password. + **Step # 7 -** If you haven't already, then you need to point your Domain Nameservers to DigitalOcean Read More. + **Step # 8 -** Go to **`Networking -> Domains`** and Add your Domain. + **Step # 9 -** Lastly, create 2 new records for your domain as listed below: + + ```php + Hostname : @ + Will direct to : your-server-ip-address + TTL : 1800 + + Hostname : www + Will direct to : your-server-ip-address + TTL : 1800 + ``` + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/changelog.md b/resources/docs/teams/changelog.md new file mode 100644 index 0000000..447a690 --- /dev/null +++ b/resources/docs/teams/changelog.md @@ -0,0 +1,21 @@ +# LaraPass v2 Teams Version Changelog + +All changes made in `LaraPass v2 Teams Version` releases are recorded here. + +Added +Updated +Fixed + +--- + +- [1.0.0](#1.0.0) +- [ Help us improve this page!](#) + + +## Release **`1.0.0`** | 12-Mar-2021 + + + Added Initial release of LaraPass v2 Teams Version available for pre-order on www.larapass.net
+
+ +--- diff --git a/resources/docs/teams/demo-videos.md b/resources/docs/teams/demo-videos.md new file mode 100644 index 0000000..497e6d9 --- /dev/null +++ b/resources/docs/teams/demo-videos.md @@ -0,0 +1,58 @@ +# Demo Videos - Teams Version + +All Demo Videos of `LaraPass v2 Teams Version` + +> {primary} We will be updating this page regularly as more videos of demos or features are recorded and made available. + +--- + +- [Setup Videos](#setup) +- [Installation Videos](#installation) +- [Settings Videos](#settings) +- [ Help us improve this page!](#) + + +## Setup Videos + +All Setup Demos for LaraPass v2 using different service providers. + +

+ + Installation-Demo-Video + + +

+ +--- + +## Installation Videos + +All Installation Demos (and releated) for LaraPass v2. + +

+ + Installation-Demo-Video + +

+ +--- + +## Settings Videos + +All Settings Demos for LaraPass v2. + +

+ + Installation-Demo-Video + + + Auto-Updater-Demo-Video + +

+ +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/index.md b/resources/docs/teams/index.md index 719a607..1102e7c 100644 --- a/resources/docs/teams/index.md +++ b/resources/docs/teams/index.md @@ -1,2 +1,28 @@ - ## Get Started - - [Overview](/{{version}}/overview) \ No newline at end of file + - [Overview](/{{version}}/overview) + - [Introduction](/{{version}}/introduction) + - [Changelog](/{{version}}/changelog) + - [Basic Setup](/{{version}}/basic-setup) + - [Demo Videos](/{{version}}/demo-videos) +- ## Setup + - [Cloudways](/{{version}}/setup/cloudways) + - [cPanel Host](/{{version}}/setup/cpanel) +- ## Installation + - [Installation](/{{version}}/installation/overview) + - [After Installing](/{{version}}/installation/after-installing) +- ## Admin Features + - [Overview](/{{version}}/admin/overview) + - [User Management](/{{version}}/admin/user-management) + - [Pages Manager](/{{version}}/admin/pages-manager) + - [General Settings](/{{version}}/admin/general-settings) + - [Email Settings](/{{version}}/admin/email-settings) + - [System Settings](/{{version}}/admin/system-settings) + - [Automation Settings](/{{version}}/admin/automation-settings) + - [LaraPass Settings](/{{version}}/admin/larapass-settings) + - [Modules Manager](/{{version}}/admin/modules-manager) +- ## Multi-Language + - [Translations](https://github.com/LaraPass/Translations) +- ## Miscellaneous + - [Social Logins](/{{version}}/misc/social-logins) + - [Google reCaptcha](/{{version}}/misc/recaptcha) + - [Mailgun Setup](/{{version}}/misc/mailgun) \ No newline at end of file diff --git a/resources/docs/teams/installation/after-installing.md b/resources/docs/teams/installation/after-installing.md new file mode 100644 index 0000000..2f04fa0 --- /dev/null +++ b/resources/docs/teams/installation/after-installing.md @@ -0,0 +1,76 @@ +# After Installing - Teams Version + +After Installation Guide for `LaraPass v2 Teams Version`. + +--- + +- [Outgoing Mailer](#mailer) +- [Cron Job](#cron) +- [Privacy & Terms Pages](#pages) +- [ Help us improve this page!](#) + + +## Outgoing Mailer + +LaraPass v2 sends allot of transactional emails for a variety of reasons such as - email verification, team invites, new device login, password reset, account information, limit notifications, personal data requests, etc., as such an outgoing mailer needs to be setup and configured. If you don't setup one, several critical functions of LaraPas v2 won't work (during testing/development you can set the mailer as `log` and all outgoing mails will be stored in `/storage/logs/laravel.log` file). + +> {primary} Detailed instructions on how to setup your mailer can be found [`here`](../admin/email-settings) + +--- + + +## Cron Job + +LaraPass v2 uses scheduled tasks to automatically execute certain actions such as clearing logs, taking database backups, deleting marked accounts, etc. As such, you need to enabled/setup a cron job to run on your server. +
+In order to setup cron job, navigate to the cron jobs page on your hosting panel, select the interval at which the cron jobs should run at (ideally you should set every minute or every 5 minutes), and then add the following command (along with the directory of larapass on your server) - + +--- + +**`Cron jon command on Cloudways`** +```php +* * * * * php /home/master/applications/app_root_name/public_html/artisan schedule:run >> /dev/null 2>&1 +``` +Replace **'app_root_name'** with the random text/name generated by cloudways for your app. +

cloudways-cron

+ +--- + +**`Cron job command on cPanel`** +```php +/usr/local/bin/ea-php74 /path_to_larapass_directory/artisan schedule:run >/dev/null 2>&1 +``` +Replace **'path_to_larapass_directory'** with the actual path to your larapass directory on the cpanel server (refer screenshot below). +

cloudways-cron

+ +--- + +**`Cron job command on Ploi.io`** +```php +php /path_to_larapass_directory/artisan schedule:run +``` +Replace **'path_to_larapass_directory'** with the actual path to your larapass directory on the ploi server (refer screenshot below). +

cloudways-cron

+ + +> {primary} If your host doesn't allow setting up cron jobs, don't worry, it doesnt effect the performace of the app, you can always run these commnds manually through the command line. More details [`here`](../admin/automation-settings) + +--- + + +## Privacy & Terms Pages + +LaraPass v2 comes with a build in page manager out of the box with a WYSIWYG editor. We have inserted placeholders for your app's Privacy & Terms of Service Pages which you can easily edit and update with your terms and wordings by opening the pages manager here - + +```php +yourdomain.com/admin/pages +``` +and clicking on the `Edit` button under the Privacy Page or the Terms of Service Page. + +> {primary} Detailed instructions on how to manage your pages can be found [`here`](../admin/pages-manager) + +--- +
+ + + diff --git a/resources/docs/teams/installation/overview.md b/resources/docs/teams/installation/overview.md new file mode 100644 index 0000000..78227c7 --- /dev/null +++ b/resources/docs/teams/installation/overview.md @@ -0,0 +1,118 @@ +# Installation Overview - Teams Version + +Detailed Installation Guide for `LaraPass v2 Teams Version`. + +--- + +- [Downloading](#downloading) +- [Uploading](#uploading) +- [Installing](#installing) +- [Installation Demo Video](#installation-demo) +- [ Help us improve this page!](#) + + +## Downloading + +Download the latest files of **Larapass v2 Teams Version** from our portal [**`here`**](https://larapass.net/app/downloads) + +> {primary} If you have purchased your LaraPass v2 copy from **Codecanyon**, **Gumroad** or **Codegrape**, you need to first import your license on our portal to get a valid License Key. You can import your license at [`larapass.net`](https://larapass.net/app/licenses/import) + +Extract all the files into a safe location. Also extract the **`laravel_source`** zip_file into a folder (it contains all the main files we will be uploading to our server). + + +--- + + +## Uploading + +Open connection to your server using **`Bitvise SSH Client`** or **`CyberDuck`** or **`FileZilla`** + +Navigate to the directory created for your domain. (Ex: for **`demo.larapass.net`**, the server creates the directory **demo.larapass.net**) + +Upload all the files & folders you got from the **`larapass_source`** zip_file into the website directory. + +> {info} *Becareful not to miss any file or interrupt when uploading files to the server.* + +--- + + +## Installing + +> {warning} The Installation Steps for all versions of LaraPass v2 are identical. If you have experience installing the Personal Version, the experience with the Teams Version will be no different. + +**`LaraPass v2`** comes with a installer out of the box which helps you to easily install the **`LaraPass v2`** app on any server with just few clicks. + +> {primary} *Ensure your domain / sub-domain is pointing to the `/public` directory inside the larapass app folder. (ex: the domain `demo.larapass.net` points to the directory => `demo.larapass.net/public`* + +**Step # 1 -** Navigate to + + ```php + yourdomain.com (it will automatically open the installer if the app isnt installed yet) + or + yourdomain.com/admin/install + ``` +![screenshot](/screenshots/installation/installer-1.png) + +> {info} It is recommended that you wait for your domain name dns to propagate and use `yourdomain.com/admin/install` route for installing and do use your server ip address to access. + +--- + +**Step # 2 -** If your server meets all the requirements for installing LaraPass v2, click on **`Next Step`** to proceed. +![screenshot](/screenshots/installation/installer-2.png) + +--- + +**Step # 3 -** Login to your LaraPass Portal at [**`larapass.net`**](https://larapass.net/apps/licenses). Go to **My Licenses** Menu and Add your Domain (without www.) in the Domain Options. You won't be able to verify your license key and install the app on your domain unless you whitelist your domain here. +![screenshot](/screenshots/installation/installer-3.png) + +--- + +**Step # 4 -** Verify your **`LaraPass v2 Teams Version`** License by entering the License Key your received from us. You can check all your active licenses at [**`larapass.net`**](https://larapass.net/apps/licenses) +![screenshot](/screenshots/installation/installer-4.png) + +--- + +**Step # 5 -** Once your **`LaraPass v2 Teams Version`** License is verified, you will be asked to setup & migrate your Database. Add these details and click on **Save Database**: + + ```php +1. Database Hostname : localhost or 127.0.0.1 (confirm with your hosting provider. Its the address that shows up in phpmyadmin) +2. Database Port : 3306 +3. Database Name : larapass (or the name you used when creating the database in mysql) +4. Database Username : Username of the user you linked with the database in mysql +5. Database Password : Password of the user you linked with the database in mysql + ``` +![screenshot](/screenshots/installation/installer-5.png) + +--- + +**Step # 6 -** You will get the option to **`Start Database Migration.`** Click on it, if the app is able to connect with your database, it will start the migration process and once its complete, will give you an output of all the migrated and seeder files, otherwise, if the app is unable to connect to the database, it will take you back to the database setup page and inform you of the error (invalid credentials, server down, etc). +![screenshot](/screenshots/installation/installer-6.png) + +--- + +**Step # 7 -** Setting your **LaraPass v2 Environment** - here you can setup your app name, email address, environment (production recommended), admin login credentails, and outgoing mail driver (you can setup or modify the mail driver later on from your admin settings page). +![screenshot](/screenshots/installation/installer-7.png) + +--- + +**Step # 8 -** Finally, you need to click on the **`Finish Installation`** button to finalize the app and remove the installer route. You will then be redirected to the login page, where you can login using the admin email and password you used. +![screenshot](/screenshots/installation/installer-8.png) + +This completes your **`LaraPass v2 Teams Version`** Installation process. In the next step we will learn more about configuring your app using your custom logo,etc. + +--- + + +## Installation Demo Video + +You can watch and follow through our demo installation video on youtube for a quick look at how easy & simple it is to install LaraPass v2 on your server. +
+ + + Installation-Demo-Video + + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/introduction.md b/resources/docs/teams/introduction.md new file mode 100644 index 0000000..36fecaf --- /dev/null +++ b/resources/docs/teams/introduction.md @@ -0,0 +1,106 @@ +# Introduction - Teams Version + +LaraPass v2 is a self-hosted password manager for teams. + +--- + +- [Introduction](#introduction) +- [Licenses](#licenses) +- [Other Versions](#other-versions) +- [Support](#support) +- [Customization](#customization) +- [ Help us improve this page!](#) + + +## Introduction + +> {primary} Thankyou for purchasing **LaraPass v2 Teams Version** + +This documentation will help you get familiar with **LaraPass v2**. Please don't forget to leave a **`5-star`** rating on codecanyon for **`LaraPass v2 Teams Version.`** If we didn't meet your expectations, please contact us before leaving a low rating and hopefully we can fix any issues you might have. Thankyou for your time and welcome to the family. + +> {warning} We provide **`Installation Services`** for an additional charge of **`$20`** per installation. + +If you would like to request installation of **`LaraPass v2 Teams Version`** on your sever, kindly open a support ticket at **`support.larapass.net`** with the subject **Installation Order**. + +--- + + +## Licenses + +**`LaraPass v2 Teams Version`** is sold primarily through our portal at [**www.larapass.net**](https://larapass.net/versions/teams) as well as on CodeCanyon (an Envato Marketplace). All versions of LaraPass v2 comes with 2 types of Licenses. Difference between the Regular vs Extended License for the Teams Version can be found below: + +***Regular License*** ++ Self-Hosted. ++ Licence Valid for Lifetime. ++ Free Updates for 1 year. ++ Complete Source Code. ++ Single website (commercial, personal, or non-profit). ++ Single website for a client (commercial, personal, or non-profit). ++ Single intranet site project. ++ Quality checked by **envato**. ++ End-users cannot be charged. ++ 6-months basic support included. + +***Extended License*** ++ Self-Hosted. ++ Licence Valid for Lifetime. ++ Free Updates for 1 year. ++ Complete Source Code. ++ Single website (commercial, personal, or non-profit). ++ Single website for a client (commercial, personal, or non-profit). ++ Single intranet site project. ++ Quality checked by **envato**. ++ 6-months **`priority`** support. ++ Direct access to github repo (deploy directly from our master branch into your production site). ++ Access to deploy or test out new features before anyone else. ++ Ability to contribute to the project code with full credit. ++ Any future released addon's included for free (or for 1-year if service based). ++ Free installation service (1-time). ++ Free update service (2-times). + +> {danger} Items purchased under the **`Regular`** or **`Extended`** Licenses may NOT be redistributed or resold "as-is" or as part of any other collection of image resources or files. + +--- + + +## Other Versions + +**LaraPass v2** is available in 3 different versions - + +***`Personal Version`*** / [***`Available Here`***](https://larapass.net/versions/personal) ++ For individuals who want full control over their site login data. ++ Self-hosted to prevent any 3rd-party sniffing. ++ Can allow other users or friends/family members to register and use the app for free. ++ Public or Private Mode. + +***`Teams Version`*** / [***`Available Here`***](https://larapass.net/versions/teams) ++ For small organizations who wish to store internal site login data and share it amongst team members. ++ Self-hosted to prevent any 3rd-party sniffing. ++ Personal Vaults as well as Team Vaults. ++ Add members/admins to teams, manage permissions to view/edit/delete site logins, etc. ++ Public or Private Mode. + +***`SaaS Version`*** / ***`Coming Soon`*** ++ For organizations or individuals that want to run a software-as-a-service (saas) bussiness. ++ All the features of the Personal & Teams version along with the ability charge end-users. ++ Integrated stripe subscription system. ++ Charge users for increased vault storage capacity and other functionality. ++ Offer coupons, trials, etc. Manage customers and their payments/subscriptions. + +You can purchase your desired license type from our Official Website [**here**](https://larapass.net). + +> {info} Regular Licenses (for all versions) comes with ``6 months`` standard support and updates included. Extended Licenses (for all versions) comes with ``6 months`` priority support & lifetime updates included. + +--- + + +## Support + + If you have any questions that are beyond the scope of this help file, please feel free to open a support ticket at **`support.larapass.net`** and we would be more than happy to help. + + --- + + +## Customizations + + For any customizations you can reach out to us using our support channels given above. If your customization type is requested by many others then it will be build into the system in the next release or so, if not then you can hire us to do that particular customization for you at an additional charge. \ No newline at end of file diff --git a/resources/docs/teams/misc/mailgun.md b/resources/docs/teams/misc/mailgun.md new file mode 100644 index 0000000..9a9baea --- /dev/null +++ b/resources/docs/teams/misc/mailgun.md @@ -0,0 +1,105 @@ +# Mailgun + +Setting Up Mailgun to work with your LaraPass installation + +--- + +- [Sign Up](#sign-up) +- [Add Domain](#add) +- [DNS Settings](#dns) +- [Wait For DNS](#wait-dns) +- [Ready to Use](#ready) +- [Credit](#credit) +- [ Help us improve this page!](#) + +> {warning} The Mailgun Setup Steps for all versions of LaraPass v2 are identical. You do not have to make any special changes for the Teams Version. + + +## Sign Up + +Go to [**`www.mailgun.com`**](https://refs.spargon.tech/mailgun) and SignUp for a Free Account. + + +> {primary} Mailgun Offers **`5,000 Emails/month`** for Free per month for 3 months. + +--- + + +## Add Domain + +In your **Mailgun** Control Panel, go to **`Domains`** & then click on **`Add New Domain`** + +Enter a domain you own. Please note that you can use this one domain with many services. + +Follow the 4 Steps shown on the page to complete the setup. If you are finding difficulty in following them, then go [**here**](http://code.krister.ee/mailgun-digitalocean/) for a more detailed guide + +> {info} We are using **`mg.domain.com`** subdomain just to separate concerns. Its actually easier and more practical to just use your main **`domain.com`** instead. + +![screenshot](/screenshots/misc/mailgun/add-domain.gif) + +--- + + +## DNS Settings + +Now Mailgun should have directed you to the DNS settings page. To find it manually, go to the Domains tab and select your domain. Here's a sample cropped image : + +![screenshot](/screenshots/misc/mailgun/add-dns.png) +  +##### Log into DigitalOcean and select the Networking tab on the left. +  + +![screenshot](/screenshots/misc/mailgun/do.gif) +  + +##### * Select your **`mydomain.com`** (no need to create separate subdomain). +  +##### * Use the **`Add record`** button to add all the necessary information. +  + +![screenshot](/screenshots/misc/mailgun/record.gif) + +  + +##### Basically you need to convert the Mailgun provided data into this: + +![screenshot](/screenshots/misc/mailgun/converted.png) + +### **Things to notice when entering data** ++ the txt details may need to be in double quotes: **`v=spf...`** ++ Domain values need dots at the end (DigitalOcean will tell you this) ++ the **`v=spf`** part needs an **`@`** in front, not your domain, as Mailgun instructs. ++ Mailgun domains use the extension **`.org!`** + +--- + + +## Wait for DNS records to update + +Usually this takes about 24 hours. If you're in a hurry you're welcome to go insane with the "Check DNS Records Now" button. + +--- + + +## Ready to Use + +You can now configure your LaraPass app to send emails using Mailgun. + +Open Email Settings at `https://yourdomain.com/admin/settings/email` ++ Select Mail Driver as SMTP if you want to use Mailgun SMTP Credentials. ++ Add the SMTP Credentails you got from Mailgun & Save. ++ or Select Mailgun API if you want to use Mailgun API. ++ Add the Mailgun API Key & Secret you got from Mailgun & Save. ++ Click on **Send Test Mail** to verify your mailer is setup properly. + +--- + + +## Credit + +This Mailgun tutorial was borrowed from **`Krister Viirsaar`**. You can check out his original post [**`here`**](http://code.krister.ee/mailgun-digitalocean/) + +--- +
+ + \ No newline at end of file diff --git a/resources/docs/teams/misc/recaptcha.md b/resources/docs/teams/misc/recaptcha.md new file mode 100644 index 0000000..610a3d8 --- /dev/null +++ b/resources/docs/teams/misc/recaptcha.md @@ -0,0 +1,62 @@ +# Google reCaptcha + +Setting Up Google Invisible reCaptcha to work with your LaraPass App. + +--- + +- [Sign Up](#signup) +- [Register Your Site](#register) +- [Add Keys to App](#keys) +- [Activate reCaptcha](#activate) +- [ Help us improve this page!](#) + +> {warning} The Google reCaptcha Setup Steps for all versions of LaraPass v2 are identical. You do not have to make any special changes for the Teams Version. + + +## Sign Up + +Go to [**`www.google.com/recaptcha/admin`**](https://www.google.com/recaptcha/admin) and Sign Up for Google's reCaptcha Services. + + +> {primary} Google reCaptcha is a **`Free`** service provided by Google. You can use your regular google/gmail account for the same. + +--- + + +## Register Your Site + +Once signed-up, you will be asked to register your site. + +![screenshot](/screenshots/misc/recaptcha/register.png) + +Enter a Label/Name for the Key (for self-identification) + +Under reCAPTCHA Type - Select reCAPTCHA v2 & then Select Invisible reCAPTCHA Badge as shown below - + +![screenshot](/screenshots/misc/recaptcha/v2.png) + +Add your domains & sub-domains. Add localhost if you to test larapass on your localhost system under "Domains" + +![screenshot](/screenshots/misc/recaptcha/domains.png) + +Accept Terms & Click on Submit. + +> {info} Once you click on submit, you will get your ``reCAPTCHA`` keys. Store the ``SITE_KEY`` & ``SECRET_KEY`` safely. + +--- + + +## Add reCaptcha Keys to your App + +Go to Admin Menu -> Settings. Under ``Application Settings`` you have two fields for **Google reCaptcha Site Key** and **Google reCaptcha Secret Key**. + +Take the Site & Secret Keys you got from Google Console and add it here & click on update. + +Google Invisible reCaptcha Service is now active. + +Visit ``yourapp.com/register`` to test it out. + +--- +
+ + diff --git a/resources/docs/teams/misc/social-logins.md b/resources/docs/teams/misc/social-logins.md new file mode 100644 index 0000000..b7b704a --- /dev/null +++ b/resources/docs/teams/misc/social-logins.md @@ -0,0 +1,73 @@ +# Social Logins using OAuth + +Guide to setup Social Logins using OAuth for your App. + +--- + +- [Overview](#Overview) +- [Enable Social Logins](#enable) +- [Github Login Setup](#github) +- [Facebook Login Setup](#facebook) +- [Twitter Login Setup](#twitter) +- [ Help us improve this page!](#) + +> {warning} The Social Logins Setup Steps for all versions of LaraPass v2 are identical. You do not have to make any special changes for the Teams Version. + + +## Overview + +LaraPass v2 uses OAuth for enabling Social Logins. OAuth (2.0) is the industry-standard protocol for authorization. It allows for easy flow of information (as much authorized) from one-point-to-another, in our case, from the social media site to your LaraPass v2 App. + +--- + + +## Enable Social Logins + +Details on how/where to add your OAuth credentials can be found [**`here`**](../admin/modules-manager#social) On this page, we will be focusing on learning how to get the credentails (an API Key & a Secret Key) from the social netwrok (Github, FB, Twitter, etc). + +--- + + +## Github Login Setup + +Follow the steps below to create an OAuth app on Github and get your API & Secret Key. + +`+` **`Step # 1`** - Login to your Github account - you can use your personal account or your organizations' account (imo using an official organization account brings legitimacy). + +`+` **`Step # 2`** - Go to **Developer Settings**. For personal accounts you can find it here - `https://github.com/settings/developers`, for organization accounts, you will find it here - `https://github.com/organizations/your_organization/settings/applications` + +`+` **`Step # 3`** - Click on **Register a new application** or **New OAuth App**. + +`+` **`Step # 4`** - Enter your app name (something thats recognizable by users). + +`+` **`Step # 5`** - The URL of your app, ex: for our demo its `https://personal-demo.larapass.net` + +`+` **`Step # 6`** - A few words describing your app/site. + +`+` **`Step # 7`** - **Authorization callback URL** - Take the app url from **Step # 5** and add **`/login/github/callback`** at the end. This is important. Ex: in our demo the Callback URL is **`https://personal-demo.larapass.net/login/github/callback`**. + +`+` **`Step # 8`** - Once created, you can add your app's logo (improves identification) and done. You will now have access to your OAuth App Client ID and Secret Key (as shown below). + +`+` **`Step # 9`** - Enter these in the Social Logins Module, Enable it and voila, you are good to go. + +![screenshot](/screenshots/misc/social/github-creds.png) + + +--- + + +## Facebook Login Setup + +Coming Soon! + +--- + + +## Twitter Login Setup + +Coming Soon! + +--- +
+ + diff --git a/resources/docs/teams/overview.md b/resources/docs/teams/overview.md index e38126b..2fa4660 100644 --- a/resources/docs/teams/overview.md +++ b/resources/docs/teams/overview.md @@ -1,10 +1,87 @@ # LaraPass v2 Teams Version +A Self-Hosted Password Manager for Teams. + +--- + +- [Overview](#overview) +- [Features](#features) +- [Credits](#credits) +- [Contribute](#contribute) +- [ Help us improve this page!](#) + + +## Overview + +**LaraPass v2** is a self-hosted password manager for teams that allows you to store all of your important site login details and information into secure vaults on your own servers and share them among your team members thereby guaranteeing highest level of security and discretion 😏. **LaraPass v2** is build using the amazing Laravel PHP Framework (v8.x) and the beautiful, responsive UI is powered by the Stisla Template (by *Muhamad Nauval Azhar*) using Bootstrap 4, along with powerful Livewire Components. + +--- + + +## Features + +**LaraPass v2 Teams Version** comes with a plethora of features right out of the box. + +**`For Users`** ++ Secure Vaults to store sites, notes, etc (Add extra layer of protection by password protecting individual vaults). ++ Store Site Login Info in Encrypted form along with notes & custom fields. ++ Two Factor Authentication System (using an Authenticator App) for increased Security. ++ Get notified via Email whenever you log in from a new device. ++ Password Generator - Custom build Password Generator to generate strong, highly secured password strings with just one-click. ++ Beautiful and responsive layout for immersive user experience. ++ Easily copy account details with just one-click. ++ Folders - Allows you to organize sites in separate folders to avoid any unnecessary confusion. ++ Receive Custom Emails for Verification, Welcome, Password Reset, New Device Login, Team Invite, etc. ++ Create New Teams or Join any existing Teams through an Invite. ++ Quick and robust search system to search through your catelog of sites from different personal or team vaults. + +**`For Teams`** ++ Create separate teams and invite registered members to join your team. ++ Separate team vaults for each team. Keep your team's site data isolated from other teams. ++ Assign teams roles (Team Admin, Team Member, Team Intern) and manage permissions (per user): + + **Team Admin** - Access to all of the team settings and data. Can invite, update (roles) or remove members from the team. Can view team logs and if needed, Delete the entire team. + + **Team Member** - Can access team vaults, sites and folders. Update data if required. Cannot invite or remove members from the team. + + **Team Intern** - Very limited access. Can only view data of the vaults, sites and folders in it. Cannot update, share, move or delete any of the team's data. + +**`For Admins`** ++ LaraPass Installer included for simple few clicks installation experience. ++ Overview - Get quick stats of the app. ++ Announcements - Send app wide announcements to all users of the app. ++ Pages Manager - Manage custom static pages (currently only Terms & Privacy Pages available). ++ User Manager - View, Add, Update, Verify, Suspend, Ban or Delete Users. ++ Team Manager - View, Update or Delete Teams or Team Members. ++ Admin Manager - Manage General, Email, System & Automation Settings: + + **General Settings** - Manage App name, email, address, logo, favicon, language, footer, and theme settings among others. + + **Email Settings** - Manage output email services (smtp, mailgun api, etc). + + **System Settings** - Manage Maintenance Mode, default storage, Public/Private mode & database settings. + + **Automation Settings** - Manage Backups, Optimization & Automated Scheduled Tasks (thru cron jobs). ++ Module Manager - Enable/Disable & Manager 1st Party Modules: + + **Teams Module** - Enable teams module to enable the teams functionality in your app. Manage general configuration for teams (max. members allow, max. vaults, max. sites, etc). + + **Two Factor Authentication Module** - Enable TFA Module to allow users to setup Two Factor Authentication (TOTP Based) using an Authenticator App like Google Authenticator. + + **Google reCaptcha Module** - Add Google reCaptcha Check to the registration page to prevent bot/spam registrations. Adivsed for apps opening Public Registrations. + + **Social Logins Module** - Allow users to register/login using their social media account. Currently supports Github, Facebook & Twitter. + +--- + + +## Credits + +**LaraPass** uses internally some open-source third-party libraries/packages, many thanks to the web community: + ++ **`Laravel`** - Open source full-stack framework. ++ **`Muhamad Nauval Azhar`** - Thanks for the Stisla Template. ++ **`Bootstrap 4`** - Open source front end framework. ++ **`Livewire`** - A full-stack framework for Laravel by Caleb Porzio. ++ **`Spatie`** - Various amazing packages from Spatie.be. ++ **`spargon/laravel-auth-logger`** - Sends notifications when logging-in on new system/location. ++ **`techtailor/rpg`** - Random Password Generator & Encrypter for Laravel. ++ **`pragmarx/google2fa`** - Google TwoFactor Authentication Library. + --- -- [Coming Soon](#coming-soon) + +## Contribute - -## Coming Soon +**LaraPass v2** **Docs** are designed to guide our users through the installation process and help inform them of all the amazing features that **LaraPass v2** offers in detail. If you think there is anything missing in the docs, or you could make it more readable and better understandable for others, then visit the github page below and start contributing. Any contribution would be much appreciated & fully credited. -LaraPass v2 Teams version is currently in development. Docs will be updated when its ready for release. \ No newline at end of file +> {primary} **LaraPass v2 Docs Repository**   **`https://github.com/LaraPass/Docs`** \ No newline at end of file diff --git a/resources/docs/teams/setup/cloudways.md b/resources/docs/teams/setup/cloudways.md new file mode 100644 index 0000000..f299840 --- /dev/null +++ b/resources/docs/teams/setup/cloudways.md @@ -0,0 +1,97 @@ +# Cloudways Setup Guide + +LaraPass v2 Setup Guide for Cloudways. + +--- + +- [Sign Up](#sign-up) +- [Deploy](#deploy) +- [Setup](#setup) +- [Upload](#upload) +- [Installing](#installing) +- [Watch Demo Video](#video) +- [ Help us improve this page!](#) + +The Ultimate Managed Hosting Platform + + +## Sign Up + +If you don't already have one, then sign-up for a free Cloudways account by clicking `here.` + +--- + +> {warning} The Cloudways Setup Steps for all versions of LaraPass v2 are identical. You do not have to make any special changes for the Teams Version. + + +## Deploy Your Server/Application + +Login to your cloudways account. Click on `Server` option in the menu & click on the `Launch` button. + ++ Select your Application >> PHP Custom App ++ Enter Name for the App and the Server & Select a Project for it. ++ Select your hosting provider (you can choose from Digital Ocean, Linode, Vultr, AWS & GoogleCloud) - Note: You don't need separate accounts for these, cloudways will pay for and manager all the servers. ++ Select the Server Size (you can start off with the smallest size and then upgrade to bigger servers when you start getting higher usage). ++ Select Location (the closest to you). ++ Click on Launch Now and watch the magic happen (this process will take 5-10 minutes to complete). +
+ +![screenshot](/screenshots/setup/cloudways/configuration.png) + +--- + + +## Setup + +Prepare your server to run LaraPass v2. + ++ Copy the IP Address of the newly deployed server. +![screenshot](/screenshots/setup/cloudways/server.png) + ++ Go to your Domain Manager and Add an A record to point your domain to this new server. ++ Open your App, Go to **Domain Management** and add your domain/website address there. +![screenshot](/screenshots/setup/cloudways/domain.png) ++ Next > Go to SSL Certificate and Add a Let's Encrypt SSL (or if you are using a custom one, you can add that). +![screenshot](/screenshots/setup/cloudways/ssl.png) ++ Lastly > Go to Application Settings & under **WEBROOT** add `public` and Save. The final directory would be `public_html/public` - +![screenshot](/screenshots/setup/cloudways/webroot.png) + +--- + + +## Upload + +Upload LaraPass v2 files to your cloudways server. + ++ Get the SFTP Login details from the **Access Details** Section. ++ Open Cyberduck (or any other SFTP program) & Login using said details. ++ Navigate to the `public_html` directory and delete any files inside there. ++ Upload all the files found in **`larapass_source`** folder (that you got from us) into the **`public_html`** directory. ++ And you are done. Navigate to `yourdoman.com` and you should see the Installation menu. ++ Lastly, don't forget to copy your MYSQL Database Username and Password from the **Access Details** page. + +> {info} You can follow the installation instructions and installation demo video [`here`](../installation/overview#installing) + +--- + + +## Installing LaraPass v2 + +Follow the instructions on the Installation page [**here.**](../installation/overview#installing) + +--- + + +## Watch Demo Video + +Watch the demo of us setting up our cloudways account server. +
+ + + Installation-Demo-Video + + +--- +
+ + diff --git a/resources/docs/teams/setup/cpanel.md b/resources/docs/teams/setup/cpanel.md new file mode 100644 index 0000000..22c5086 --- /dev/null +++ b/resources/docs/teams/setup/cpanel.md @@ -0,0 +1,132 @@ +# cPanel Setup Guide + +LaraPass v2 Setup Guide for a cPanel Powered Host. + +--- + +- [Sign Up](#sign-up) +- [Setup cPanel](#setup) +- [Create Database](#database) +- [Installing](#installing) +- [Watch Demo Video](#video) +- [ Help us improve this page!](#) + +> {warning} The cPanel Setup Steps for all versions of LaraPass v2 are identical. You do not have to make any special changes for the Teams Version. + + + + +## Sign Up + +If you don't already have one, you can sign-up for a cheaper cPanel Shared Hosting from **`A2Hosting`** + +> {info} LaraPass v2 will work perfectly on a Shared Hosting server, however if your hosting, provider has certain limitations on permissions or forces public_html directory for all, then the Auto-Updater may not be able to perform, as such, we recommend using a VPS instead of Shared Hosting. + +--- + + +## Setting up cPanel + +Login to your cPanel Host account (usually available at the url address **``yourdomain.com:2082``** ). +
+ +`+` **`Step # 1`** - Navigate to the **``Domains``**, **``Addon Domains``** or **``Sub-domains``** (depending on which type of domain you want to use. For this example we will be using a sub-domain, so click on the Sub-Domains Page in your cPanel (the proceedure is almost same for all types of domains). + +--- + +`+` **`Step # 2`** - Pick a new subdomain, in our case we will be testing with ``demo`` + +--- + +`+` **`Step # 3`** - Select a domain, in our case its `larapass.net`, so the full url of our demo app will be `demo.larapass.net` +
+ +![screenshot](/screenshots/setup/cpanel/sub.png) + +--- + +`+` **`Step # 4`** - Ensure that the **Document Root** is pointing towards **/larapass/public** directory and under **Redirect** it says `not redirected`. +
+ +![screenshot](/screenshots/setup/cpanel/sub_added.png) + +--- + +`+` **`Step # 5`** - Open File Manager in cPanel or login to your server using an FTP program such as FileZilla or CyberDuck. Navigate to the **root** directory. Create a new folder with the name `larapass` if it doesn't already exists. If it already exists, then open it and delete all the files inside. +
+ +![screenshot](/screenshots/setup/cpanel/larapass.png) + +--- + +`+` **`Step # 6`** - Extract all the files from the **larapass_source.zip** file you received from us or downloaded from codecanyon and upload all the extracted files into the `larapass` folder on your server. +
+ +![screenshot](/screenshots/setup/cpanel/lp.png) + +--- + +`+` **`Step # 7`** - And you are done. Create a Database in the next step and navigate to your site. + +--- + + +## Create Database + +Before you can proceed with the installation, you need to create a MySQL Database. To do this, + +`+` **`Step # 1`** - Open your cPanel. Open **MySQL® Databases** under **Databases**. + +--- + +`+` **`Step # 2`** - Create a new database with a name of your choice. +
+ +![screenshot](/screenshots/setup/cpanel/mysqldb.png)setup + +--- + +`+` **`Step # 3`** - Create a new database **User** (with a unique password). +
+ +![screenshot](/screenshots/setup/cpanel/mysqlusers.png) + +--- + +`+` **`Step # 4`** - Add the newly created **user** to the larapass database you just created and +
+ +![screenshot](/screenshots/setup/cpanel/mysqldbuser.png) + +--- + +`+` **`Step # 5`** - add ALL PRIVILIGES to that user - +
+ +![screenshot](/screenshots/setup/cpanel/mysqluserpriv.png) + +> {success} Note down the ``Database Name``, ``Username`` and ``Password`` to be used in the next step for Installation. + +--- + + +## Installing LaraPass + +Follow the instructions on the Installation page [**here.**](../installation/overview#installing) + +--- + + +## Watch cPanel Setup Demo Video + +Watch the demo of us setting up our cPanel account. +
+ + + Installation-Demo-Video + + +--- +
+ +