Documentation

Getting started

Introduction

This page describes the installation and configuration steps of phpRank 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 sure your server meets the requirements below.

Software Modules
PHP 8.1.x BCMath, Ctype, Fileinfo, JSON, Mbstring, OpenSSL, PDO, Tokenizer, XML, GD, cURL
Apache 2+ mod_rewrite
MySQL 5.7.7+
MariaDB 10.3.17+

Installation

Creating the database

  1. Create a new MySQL database.
  2. Create a new MySQL username and password.
  3. Assign full privileges to your database username.
Useful resources

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

Configuring the files

Set the access permissions (CHMOD) to 775 to the following files and folders:

  • Files
    • .env
  • Folders
    • bootstrap/cache
    • lang
    • public/uploads/brand
    • public/uploads/users
    • storage
    • storage/framework/
    • storage/framework/cache
    • storage/framework/cache/data
    • storage/framework/sessions
    • storage/framework/views
    • storage/logs
Useful resources

Changing the public directory

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 folder.

Useful resources

Finishing the installation

  1. Go to https://example.com/install and follow the installation wizard to complete the installation.
  2. After you've installed the software, login into your user account.
  3. Once logged-in, go to https://example.com/admin and activate your License Key.
Useful resources

Configuration

Cron job

The software requires a cron job task to be set up on your server in order to automate some of its functions.

  1. Go to Admin Settings Cron job.
  2. Copy the Command field and set up a cron job for it that runs every minute.
Useful resources

Email

  1. Go to Admin Settings Email.
  2. Change the Driver field value to SMTP.
  3. Fill in the rest of the fields with the SMTP credentials from your SMTP provider.

Authentication

Google

  1. Login into your Google Cloud Console account.
  2. Create a New Project.
  3. Go to APIs and Services.
  4. From the sidebar, go to OAuth Consent Screen section.
  5. Set the User Type field value to External and click on Create button.
  6. Fill in your app details, and click on Save and continue button.
  7. 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.
  8. From the sidebar, go to Credentials section.
  9. Click on Create credentials button and then select OAuth client ID.
  10. Set the Application type field value to Web application.
  11. On the Authorized redirect URIs field paste your redirect URL, which can be found in Admin Settings Authentication Google.
  12. Copy the Client ID and the Client secret in Admin Settings Authentication Google.

Microsoft

  1. Login into your Microsoft Azure account.
  2. Go to App registrations and click on New registration button.
  3. Set the Supported account types field value to Personal Microsoft accounts only.
  4. 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.
  5. Go to App registrations, click on All applications tab, and select your application.
  6. Copy the Application (client) ID in Admin Settings Authentication Microsoft.
  7. From the sidebar, go to Certificates & secrets section, and then click on the New client secret button.
  8. Copy the Client secret Value in Admin Settings Authentication Microsoft.

Apple

  1. Login into your Apple developer account.
  2. Go to Apple Membership section.
  3. Copy the Team ID in Admin Settings Authentication Apple.
  4. Go to Identifiers and then click on the Plus button.
  5. Register a new App ID, with the Sign in with Apple feature enabled under the Capabilities field.
  6. Go to Identifiers section, and then click on the Plus button.
  7. Register a new Service ID, and then select it from the list.
  8. 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.
  9. Copy the Service ID Identifier in Admin Settings Authentication Apple.
  10. Go to Keys section, and then click on the Plus button.
  11. Enable the Sign in with Apple option, and click on Configure button, and set the Primary App ID, and create your key.
  12. Copy the Key ID in Admin Settings Authentication Apple.
  13. 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.

Captcha

reCAPTCHA

  1. Login into your Google reCAPTCHA account.
  2. Click on Create button to register a new site.
  3. Set the reCAPTCHA type field value to Challenge (v2), and then to Invisible reCAPTCHA badge, and fill in the rest of the fields.
  4. Copy the Site key and the Secret key in Admin Settings Captcha.
  5. Change the Driver field value to reCAPTCHA in Admin Settings Captcha.

hCaptcha

  1. Login into your hCaptcha account.
  2. Create a new Site.
  3. Fill all the other fields with the requested information.
  4. Copy the Site key in Admin Settings Captcha.
  5. From the Settings page, copy the Secret key in Admin Settings Captcha.
  6. Change the Driver field value to hCaptcha in Admin Settings Captcha.

Turnstile

  1. Login into your Cloudflare account.
  2. From the sidebar, go to the Turnstile section.
  3. Click on Add site.
  4. Set the Widget Mode field value to Invisible, and fill in the rest of the fields.
  5. Copy the Site key and the Secret key in Admin Settings Captcha.
  6. Change the Driver field value to Turnstile in Admin Settings Captcha.

Payment processors

To enable any of the payment processors, an Extended license is required. The payment processors can be enabled from Admin Settings Payment processors.

PayPal

  1. Login into your PayPal account.
  2. Go to the My apps & credentials section, click on Live button and then on the Create app button.
  3. Copy the Client ID and Secret in Admin Settings Payment processors PayPal.
  4. Go to the My apps & credentials section, click on Live button and then select your app.
  5. Scroll down to LIVE WEBHOOKS and click on the Add webhook button.
  6. On the Webhook URL field paste your webhook URL, this can be found on Admin Settings Payment processors PayPal.
  7. Under the Events types select All events and save your changes.
  8. Go to the My apps & credentials section, click on Live button and then select your app.
  9. Copy the Webhook ID in Admin Settings Payment processors PayPal.

Stripe

  1. Login into your Stripe account.
  2. From the menu bar, go to the Developers section of the Stripe dashboard and click on API Keys.
  3. Copy the Publishable key and Secret key in Admin Settings Payment processors Stripe.
  4. From the menu bar, go to the Developers section of the Stripe dashboard and click on Webhooks.
  5. Click on Add a new endpoint.
  6. On the Endpoint URL field paste your webhook URL, which can be found on Admin Settings Payment processors Stripe.
  7. On the events to listen to field, click on Select all events, and click on Add events button.
  8. Click on Add endpoint button to create your webhook endpoint.
  9. Copy the Signing secret in Admin Settings Payment processor Stripe.

Razorpay

  1. Login into your Razorpay account.
  2. From the menu bar, go to the Settings section of the Razorpay dashboard and click on API Keys.
  3. Click on Generate key button.
  4. Copy the Key ID and Key secret in Admin Settings Payment processors Razorpay.
  5. From the menu bar, go to the Settings section of the Razorpay dashboard and click on Webhooks.
  6. Click on Add new webhook.
  7. On the Webhook URL field paste your webhook URL, which can be found on Admin Settings Payment processors Razorpay.
  8. On the Secret field add your own secret passcode.
  9. On the Active events field select all the Payment events and Subscription events.
  10. Click on Create webhook button to create your webhook endpoint.
  11. Copy the Secret passcode in Admin Settings Payment processor Razorpay.

Paystack

  1. Login into your Paystack account.
  2. From the menu bar, go to the Settings section of the Paystack dashboard and click on API Keys & Webhooks.
  3. Copy the Public key and Secret key in Admin Settings Payment processors Paystack.
  4. From the menu bar, go to the Settings section of the Paystack dashboard and click on API Keys & Webhooks.
  5. On the Webhook URL field paste your webhook URL, which can be found on Admin Settings Payment processors Paystack.

Coinbase

  1. Login into your Coinbase account.
  2. From the sidebar, go to the Settings section of the Coinbase dashboard and scroll down to API keys.
  3. Create an API key, and copy the key in Admin Settings Payment processors Coinbase.
  4. From the sidebar, go to the Settings section of the Coinbase dashboard and scroll down to Webhook subscriptions.
  5. Click on Add an endpoint.
  6. On the Endpoint URL field paste your webhook URL, this can be found on Admin Settings Payment processors Coinbase.
  7. From the sidebar, go to the Settings section of the Coinbase dashboard and scroll down to Webhook subscriptions.
  8. Click on Show shared secret.
  9. Copy the Webhook shared secret in Admin Settings Payment processors Coinbase.

Crypto.com

  1. Login into your Crypto.com account.
  2. From the menu bar, go to the Integrations section of the Crypto.com dashboard and click on API Keys.
  3. Copy the Publishable key and Secret key in Admin Settings Payment processors Crypto.com.
  4. From the menu bar, go to the Integrations section of the Crypto.com dashboard and click on Webhooks.
  5. Click on Add webhook button.
  6. On the Payload URL field paste your webhook URL, which can be found on Admin Settings Payment processors Crypto.com.
  7. Copy the Signature secret in Admin Settings Payment processor Crypto.com.

Bank

  • All fields are optional.

Storage

When migrating from Local storage to an S3 filesystem storage, you must upload what's inside the /public/uploads folder from your server to your S3 filesystem storage.

Amazon S3

  1. Login into your Amazon Web Services account.
  2. Go to the Amazon S3 section, click on Create bucket button, fill in the Bucket name field, set the Object Ownership field to ACLs enabled, and uncheck the Block Public Access field (you'll be prompted to agree with the changes), and then click on the Create bucket button.
  3. Copy the Bucket in Admin Settings Storage.
  4. Go to the Amazon S3 regions section and copy your Region and Endpoint URL in Admin Settings Storage.
  5. Go to the Security credentials section, click on the Create access key button and create your access key.
  6. Copy the Access Key and Secret Key in Admin Settings Storage.

DigitalOcean Spaces

  1. Login into your DigitalOcean account.
  2. Go to the Spaces Object Storage section, click on Create Spaces Bucket button, fill in the Bucket Name field, and then click on the Create a Spaces Bucket button.
  3. Extract the <bucket> value and the <region> value from the https://<bucket>.<region>.digitaloceanspaces.com URL of your Origin Endpoint field, and copy the Bucket value and Region in Admin Settings Storage.
  4. Remove the <bucket> value from the https://<bucket>.<region>.digitaloceanspaces.com URL of your Origin Endpoint field, and copy the Origin Endpoint without the <bucket> value in Admin Settings Storage.
  5. Go to the Spaces access keys section, click on Generate New Key button, fill in the name field, and then click on the Create Access Key button.
  6. Copy the Access Key and Secret Key in Admin Settings Storage.

Backblaze B2

  1. Login into your Backblaze account.
  2. Go to the Buckets section, click on Create a bucket button, fill in the Unique Bucket Name field, and set the Files in Bucket field to Public, and then click on the Create a bucket button.
  3. Copy the Unique Bucket Name and Endpoint URL in Admin Settings Storage.
  4. Extract the <region> value from the s3.<region>.backblazeb2.com URL of your Endpoint URL field, and copy the Region value in Admin Settings Storage.
  5. Go to the Application Keys section, click on Add a New Application Key button, set the Allow access to Bucket field to your bucket, and the Type of Access field to Read and Write, and then click on the Create new key button.
  6. Copy the keyID which represents the Application key and the applicationKey which represents the Secret key in Admin Settings Storage.

Advanced

Google Custom Search

  1. Follow the Google Custom Search guide to obtain a Search Engine ID and an API key.
  2. Enable the Search the entire web when creating or editing your search engine.
  3. Copy the Search engine ID and the API key in Admin Settings Advanced Google Custom Search.

KeywordsEverywhere

  1. Follow the KeywordsEverywhere guide to obtain an API key.
  2. Copy the API key in Admin Settings Advanced KeywordsEverywhere.

Thum.io

  1. Login into your Thum.io account.
  2. From the sidebar, go to the Keys section of the Thum.io and click on Generate new key.
  3. Select the Type of the key to be HTTP Referrer Domain and fill the other fields according to your requirements.
  4. Copy the API Key ID in Admin Settings Advanced Thum.io.

Update

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.

Updating

  1. Make a backup of the .env config file located on your server.
  2. Upload and replace all the files on your server with what's inside the Software folder.
  3. Restore your .env config file on your server.
  4. Go to https://example.com/update and follow the update wizard.1
  1. Updates that do not have database changes, will not show up in the update wizard.

FAQ

  • I have a support inquiry, a question or a problem, how can I contact you?

    You can contact us here.

  • What hosting do you recommend?

    We recommend using DigitalOcean, as they offer great performance and flexibility at an affordable price.

  • 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.