Doucmentation
This page describes
the installation and configuration steps of SEO
Reports software.
If you're not familiar with the instructions on this page, we
offer installation Services, for an additional fee.
Requirements
Before installing the software, please make sureyour server meets the requirements1. PHP 8.0.x PHP 8.1.x BCMath, Ctype, Fileinfo, JSON, Mbstring, OpenSSL, PDO, Tokenizer, XML, GD, cURL
2. Apache 2+ mod_rewrite
3. MySQL 5.7.7+
4. MariaDB 10.3.17+
1.Create a new MySQL
database.
2. Create a new MySQL username and password.
3. Assign full privileges to your database username.
Useful resources
cPanel
- MySQL database wizard
Plesk
- Website databases
Uploading the files
Before starting to upload the files, please make sure your file explorer has the option to view hidden files turned on. On some operating systems, the dotfiles are hidden by default.
-Upload what's inside
the Software folder on the web root folder of
your domain. This folder is generally called public_html,
html, or example.com, but
depending on your server's configuration, it might be named
differently.
-Useful resources
cPanel
- File Manager
Plesk
- Uploading content with File Manager
Set the access
permissions (CHMOD) to 775 to
the following files and folders:
Files
.env
Folders
-bootstrap/cache
-lang
-public/uploads/brand
-storage
-storage/framework/
-storage/framework/cache
-storage/framework/cache/data
-storage/framework/sessions
-storage/framework/views
-storage/logs
Configure your web
server's document / web root to point to the /public
directory of the software. For example, if you've uploaded the
software in example.com folder, your web
directory should be changed to example.com/public
Useful resources
cPanel
- New document root
Plesk
- Defining a custom document root
Finishing the installation
Go to https://example.com/install and follow the installation wizard to complete the installation.
After you've installed the software, login into your account.
Once logged-in, go to https://example.com/admin and activate your License Key.
Cron job
The software requires a cron job task to be set up on your server
in order to automate some of its functions.
Go to > Admin > Settings
> Cron job.
Copy the Command field and set up a cron job for
it that runs every minute
Useful resources
cPanel
- Cron jobs
Plesk
- Scheduling tasks
Go to > Admin > Settings
> Email.
Change the Driver field value to SMTP.
Fill in the rest of the fields with the SMTP credentials from your
SMTP provider.
1. Login into your Google
Cloud Console account.
Create a New
Project.
Go to APIs
and Services.
From the sidebar, go to OAuth
Consent Screen section.
Set the > User Type field value
to External and click on Create button.
Fill in your app details, and click on Save and continue button.
On the Scopes section, click on Add or remove scopes button and
select the userinfo.email and userinfo.profile scopes, and
complete the remaining steps.
From the sidebar, go to Credentials
section.
Click on Create credentials button and then select OAuth
client ID.
Set the > Application type field
value to Web application.
On the > Authorized redirect URIs
field paste your redirect URL, which can be found in -
Admin > Settings > Authentication > Google.
Copy the Client ID and the Client
secret in Admin > Settings >
Authentication > Google.
Login into your Microsoft
Azure account.
Go to App
registrations and click on New
registration button.
Set the Supported account types field value to
Personal Microsoft accounts only.
Set the Platform field to Web,
and on the Redirect URI field paste your
redirect URL, which can be found in > Admin > Settings
> Authentication > Microsoft.
Go to App
registrations, click on All applications tab, and select
your application.
Copy the Application (client) ID in > Admin
> Settings > Authentication > Microsoft.
From the sidebar, go to Certificates & secrets section, and
then click on the New client secret button.
Copy the Client secret Value in > Admin
> Settings > Authentication > Microsoft.
1.Login into your Apple
developer account.
Go to Apple
Membership section.
Copy the Team ID in > Admin
> Settings > Authentication > Apple.
Go to Identifiers
and then click on the Plus
button.
Register a new App
ID, with the Sign in with Apple feature enabled under the Capabilities
field.
Go to Identifiers
section, and then click on the Plus
button.
Register a new Service
ID, and then select it from the list.
Enable the Sign in with Apple option, and click on Configure
button, and on the Return URLs field paste your
redirect URL, which can be found on > Admin >
Settings > Authentication > Apple.
Copy the Service ID Identifier in >
Admin > Settings > Authentication > Apple.
Go to Keys
section, and then click on the Plus
button.
Enable the Sign in with Apple option, and click on Configure
button, and set the Primary App ID, and create
your key.
Copy the Key ID in > Admin >
Settings > Authentication > Apple.
Click on the Download button, and with a text editor open the
downloaded file, and copy the Private key
content in Admin Settings Authentication Apple.
Login into your Google
reCAPTCHA account.
Click on Create
button to register a new site.
Set the reCAPTCHA type field value to Challenge
(v2), and then to Invisible reCAPTCHA badge, and fill in the rest
of the fields.
Copy the Site key and the Secret key
in > Admin > Settings > Captcha.
Change the Driver field value to reCAPTCHA in >
Admin > Settings > Captcha.
Login into your hCaptcha
account.
Create a new Site.
Fill all the other fields with the requested information.
Copy the Site key in >Admin
>Settings >Captcha.
From the Settings
page, copy the Secret key in Admin Settings
Captcha.
Change the Driver field value to hCaptcha in >
Admin > Settings > Captcha.
Login into your Cloudflare
account.
From the sidebar, go to the Turnstile section.
Click on Add site.
Set the Widget Mode field value to Invisible,
and fill in the rest of the fields.
Copy the Site key and the Secret key in
> Admin > Settings > Captcha.
Change the Driver field value to Turnstile
in > Admin > Settings > Captcha
To enable any of the
payment processors, an Extended license is required. The payment
processors can be enabled from > Admin > Settings
> Payment processors.
Login into your PayPal
account.
Go to the My
apps & credentials section, click on Live button and
then on the Create app button.
Copy the Client ID and Secret
in Admin Settings Payment processors PayPal.
Go to the My
apps & credentials section, click on Live button and
then select your app.
Scroll down to LIVE WEBHOOKS and click on the Add webhook button.
On the Webhook URL field paste your webhook URL,
this can be found on > Admin > Settings >
Payment processors > PayPal.
Under the Events types select All events and save your changes.
Go to the My
apps & credentials section, click on Live button and
then select your app.
Copy the Webhook ID in > Admin
> Settings > Payment processors > PayPal.
Login into your Stripe
account.
From the menu bar, go to the Developers section of the Stripe
dashboard and click on API
Keys.
Copy the Publishable key and Secret key
in > Admin > Settings > Payment processors >
Stripe.
From the menu bar, go to the Developers section of the Stripe
dashboard and click on Webhooks.
Click on Add a new endpoint.
On the Endpoint URL field paste your webhook
URL, which can be found on > Admin > Settings >
Payment processors > Stripe.
On the events to listen to field, click on Select all events, and
click on Add events button.
Click on Add endpoint button to create your webhook endpoint.
Copy the Signing secret in > Admin
> Settings > Payment processor > Stripe.
Login into your Razorpay
account.
From the menu bar, go to the Settings section of the Razorpay
dashboard and click on API
Keys.
Click on Generate key button.
Copy the Key ID and Key secret
in Admin Settings Payment processors Razorpay.
From the menu bar, go to the Settings section of the Razorpay
dashboard and click on Webhooks.
Click on Add new webhook.
On the Webhook URL field paste your webhook URL,
which can be found on Admin Settings Payment processors Razorpay.
On the Secret field add your own secret passcode.
On the Active events field select all the Payment events and
Subscription events.
Click on Create webhook button to create your webhook endpoint.
Copy the Secret passcode in Admin Settings
Payment processor Razorpay.
Login into your Paystack
account.
From the menu bar, go to the Settings section of the Paystack
dashboard and click on API
Keys & Webhooks.
Copy the Public key and Secret key
in Admin Settings Payment processors Paystack.
From the menu bar, go to the Settings section of the Paystack
dashboard and click on API
Keys & Webhooks.
On the Webhook URL field paste your webhook URL,
which can be found on Admin Settings Payment processors Paystack.
Login into your Coinbase
account.
From the sidebar, go to the Settings section of the Coinbase
dashboard and scroll down to API keys.
Create an API key, and copy the key in Admin Settings Payment
processors Coinbase.
From the sidebar, go to the Settings section of the Coinbase
dashboard and scroll down to Webhook
subscriptions.
Click on Add an endpoint.
On the Endpoint URL field paste your webhook
URL, this can be found on Admin Settings Payment
processors Coinbase.
From the sidebar, go to the Settings section of the Coinbase
dashboard and scroll down to Webhook subscriptions.
Click on Show shared secret.
Copy the Webhook shared secret in Admin Settings
Payment processors Coinbase.
Login into your Crypto.com
account.
From the menu bar, go to the Integrations section of the
Crypto.com dashboard and click on API
Keys.
Copy the Publishable key and Secret key in Admin
Settings Payment processors Crypto.com.
From the menu bar, go to the Integrations section of the
Crypto.com dashboard and click on Webhooks.
Click on Add webhook button.
On the Payload URL field paste your webhook URL,
which can be found on Admin Settings Payment processors
Crypto.com.
Copy the Signature secret in Admin Settings
Payment processor Crypto.com.
. All fields are optional.
Google Custom
Search
Follow the Google
Custom Search guide to obtain a Search Engine ID and an API
key.
Enable the Search the entire web when creating or editing your
search engine.
Copy the Search engine ID and the API
key in Admin Settings Advanced Google Custom Search.
Login into your Thum.io
account.
From the sidebar, go to the Keys section of the Thum.io and click
on Generate new key.
Select the Type of the key to be HTTP Referrer Domain and fill the
other fields according to your requirements.
Copy the API Key ID in Admin Settings Advanced
Thum.io.
Backing up
Before updating the software, you must make a complete backup of your website.
If you've made any modifications to the software's files, your changes will be lost.
Make a backup of the .env
config file located on your server.
Upload and replace all the files on your server with what's inside
the Software folder.
Restore your .env config file on your server.
Go to https://example.com/update and follow the
update wizard.
Updates that do not have database changes, will not show up in
the update wizard.
I have a support
inquiry, a question or a problem, how can I contact you?
You can contact us
Is installation included in the price?
No, installation is not included. We offer installation services
for an extra fee, please consult our Services section for more
details.
How can I translate my website?
Make a copy of the default en.json language file
found in /lang folder, and change it according
to your needs.
Where can I add my custom CSS code?
You can add your custom CSS code in Admin Settings Appearance
Custom CSS field.
Where can I add my custom JS code?
You can add your custom JS code in Admin Settings General Custom
JS field.
Where can I add my advertising unit code?
Advertising unit code can be added in the HTML template files.
Where do I find the HTML template files?
The HTML template files can be found in the /resources/views
folder. For example to edit the home page, you would edit the
/resources/views/home/index.blade.php file.
How can I create a custom page?
You can create custom page in Admin Pages.
Where can I set up my Terms of Service, Privacy Policy,
and Cookies Policy URL pages?
You can paste the links of your legal pages in Admin Settings
Legal.
Some of the Tools are missing, why?
Tools such as SERP checker, Indexed pages checker, and Keyword
research require additional configuration in order to work. For
more details please consult the Advanced section.