Magento 2 Easy Site Maintenance Extension

Document technical information

Format pdf
Size 817.6 kB
First found Nov 14, 2017

Document content analysis

Category Also themed
Language
English
Type
not defined
Concepts
no text concepts found

Persons

Organizations

Places

Transcript

USER MANUAL
TABLE OF CONTENTS
Introduction .................................................... 1
Benefits of Easy Site Maintenance ................. 1
Installation & Activation ................................. 2
Installation Steps ........................................ 2
Manual Installation (Installing Magento 2
extension by copying code) ........................ 2
Installation via Composer ........................... 3
Extension Activation ....................................... 6
Configuration .................................................. 7
Front end: ................................................. 11
Easy Site Maintenance
Version: 0.1.0
Compatibility:
Community Edition 2.0.x
Contact Us .................................................... 12
USER MANUAL – Easy Site Maintenance
Introduction
The “Easy Site Maintenance” extension when installed on your store, will allow you to put your store under
maintenance mode.
Benefits of Easy Site Maintenance
•
•
•
•
•
•
•
Gives attractive and customizable maintenance page with company’s logo.
Keeps track of visitors during maintenance mode with the help of log file.
Urgent Inquiries can be received through the “Contact Us” form.
Add countdown timer for the time when the site is going to be live.
If one has multiple store views, one can keep only the selected store view under maintenance mode.
Visitors do not need to keep checking the site, as they receive notification when the site goes live. (Note: They
should fill up the “Notify” form)
Contact the store admin in case of urgency, through the contact form.
www.appjetty.com
1
USER MANUAL – Easy Site Maintenance
Installation & Activation
Installation Steps
Manual Installation (Installing Magento 2 extension by copying code)
Step 1:
For Windows OS:
• Go to <your Magento install dir>/app/code. Under that, create the folders using following hierarchy:
o Biztech
o Easy Site Maintenance
• Go to /lib/web/fonts and move paste the Biztech_Easymaintenance directory.
For Linux OS:
• Enter the following commands keeping their order:
cd <your Magento install dir>/app/code
mkdir -p Biztech/EasySiteMaintenance
• After this, find the Download Zip and extract all files and folders in Biztech/ EasySiteMaintenance.
Step 2:
•
•
After the successful installation, you have to run the command on Magento2 root directory-“php bin/magento
setup:upgrade”.
If you see blank page or permission error, go to Terminal (Linux)/ Command Prompt (Windows).
cd [magento root directory][var]
run the following command
$ chmod –R 777 *
Step 3:
•
After running the command, log into the admin panel and clear the Cache. Go to SYSTEM →Tools (section) →
CACHE MANAGEMENT to clear the cache.
Step 4:
www.appjetty.com
2
USER MANUAL – Easy Site Maintenance
•
After the successful installation, you can see the “Easy Site Maintenance” under BIZTECH tab inside STORES →
CONFIGURATION.
Installation via Composer
Step 1:
•
Install composer from this link. If you already installed composer, skip this step.
Step 2:
•
Go to app → Code → Biztech → EasySiteMaintenance, right click on composer.json and select use composer here.
www.appjetty.com
3
USER MANUAL – Easy Site Maintenance
Step 3:
•
After that you can see command prompt where you have to run the following command:
-
composer update
Step 4:
•
Now go to [magento root directory] and right click on use Composer here.
www.appjetty.com
4
USER MANUAL – Easy Site Maintenance
Step 5:
•
You can see the cmd window and run the following command here:
-
php bin/magento setup:upgrade
Step 6:
•
After running the command, log into the admin panel and clear the Cache. Go to SYSTEM → Tools (section) →
CACHE MANAGEMENT to clear the cache.
Step 7:
•
After successful installation, you can see the “Easy Site Maintenance” under BIZTECH tab inside STORES →
CONFIGURATION.
The installation is successful! Scroll down to activate the extension.
www.appjetty.com
5
USER MANUAL – Easy Site Maintenance
Extension Activation
Step 1: Copy an activation key
•
•
•
Copy the activation key from the Order Confirmation Mail. OR
Log into your account at www.appjetty.com using the email and password you have provided at checkout
process.
Go to Downloadable Options and copy the activation key for the Easy Site Maintenance extension.
Step 2: Activate the extension
•
Log into Magento Admin Panel and go to Stores → Configuration → Biztech → Easy Site Maintenance and
enter the activation key in the ''Activation Key'' field and then click the “Save Config” button.
Step 3: Select Websites
•
When you enter and save the key it will be verified and you can select the websites where you need to use the
Easy Site Maintenance extension. Click the ''Save Config'' button after making your selections.
Now, Easy Site Maintenance Extension got activated! You just have to set
configurations.
www.appjetty.com
6
USER MANUAL – Easy Site Maintenance
Configuration
Please follow below mentioned steps to configure the “Easy Site Maintenance” extension.
Go to Stores → Configuration. In the left column under Biztech tab click on Easy Site Maintenance, you can see its
configuration sections.
Step 1: Maintenance Configuration
•
•
•
•
•
•
•
•
Activation: The extension will be deactivated by default. You need to select “Yes” and enable the extension.
Site Maintenance: Choose “Yes” to enable the maintenance mode.
Allow Front end for Admin: Choose whether to allow admin to access the site when under maintenance
mode.
Page Title: Specify the title of the maintenance page to be displayed in the title bar of the browser.
Allowed IPs: You can specify comma-separated IPs here to which the site is to be accessible even when under
maintenance mode.
Log file: Enter the name of the log file which keeps a track of users who accessed the site while under
maintenance mode.
Logo: You can upload your company logo here. The allowed formats are .jpeg, .gif and .png.
Logo Height and Logo Width: You can specify height and width of the logo uploaded above in pixels.
www.appjetty.com
7
USER MANUAL – Easy Site Maintenance



•
•
•















Background Image: Choose an image to be displayed as background on the maintenance page. The allowed
formats will be .jpeg, .gif and .png.
Bypass URL: Enter specific URLs of the website which can be accessed by visitors.
Maintenance Page HTML: You can provide HTML for the maintenance page here. Thus, you can get the
maintenance page as desired.
www.appjetty.com
8
USER MANUAL – Easy Site Maintenance
Step 2: Timer Configuration

•
•
•
•
•
•
•
•
Timer: You can enable/disable timer from here.
Make site live when Timer expires: Select “Yes” if you wish to make the site live automatically when timer
expires.
Timer Text: Enter the text to be displayed above the timer here.
Start Date and End Date: Choose the dates for the timer to be visible on your site.
Start Time and End Time: Also set the time for the above mentioned dates.
Alert Minutes: Enter the minutes before which you would like to receive and email stating your site is going to
be live.
Recipient Email: Enter the email address to which the alert email is to be send.
Email Template Content: Write the content for alert email.
www.appjetty.com
9
USER MANUAL – Easy Site Maintenance
Step 3: Contact and Notify Configuration
•
•
•
•
•
Enable: You need to enable these fields to show the “Contact us” and “Notify” forms when the site is under
maintenance.
Recipient Email: Enter the email to which details submitted by visitor using “Contact Us” form is to be send.
Notify Title: Specifies the title for the “Notify” form.
Notify Message: Enter the message to be displayed above the form fields.
Email Template Content: Write the content of the email template here, which will be sent to visitors to notify
that the site is live now.
www.appjetty.com
10
USER MANUAL – Easy Site Maintenance
Step 4: Notification Manager
•
•
•
•
Go to Easy Site Maintenance and you will be led to “Notification Manager”.
Select the records of the visitors to whom notification is to be send via email.
Select “Notify” from the actions dropdown and click submit.
The visitors will receive an email according the content set in the configuration.
Front end:
•
•
The “Easy Site Maintenance” page will be displayed as shown in the image below.
It includes timer, notification and contact us form. Hence, you would not lose business even if the site is under
maintenance mode.
All set! You are now ready to use the extension.
www.appjetty.com
11
USER MANUAL – Easy Site Maintenance
Contact Us
We simplify your business, offer unique business solution in digital web and IT landscapes.
Live Chat
Tickets
•
Get instant support with our Live Chat.
•
Raise tickets for your specific question!
•
Visit our product page at:
https://www.appjetty.com/magento2-easy-sitemaintenance.htm and click on the Live Chat button
for instant support.
•
Send an email to [email protected] or you
can login to my account www.appjetty.com
and click on My Support Tickets on your
account dashboard, to get answers to your
specific questions. Our team will work to
respond to your query prompt.
Customization:
•
If you would like to customize or discuss about additional feature for Easy Site Maintenance, please write to
[email protected]
www.appjetty.com
12
×

Report this document