Documentation

Getting started

Introduction

Installation and configuration steps of Raffyz script.

If you're not familiar with the instructions on this page, we offer installation Services for an additional fee.

Requirements

Before installing the script, please make sure your server meets the requirements below.

Requirement Minimum Version / Details
Webserver Apache with mod_rewrite or Nginx
Database MySQL 5.7.7+ or MariaDB 10.3.17+
PHP Version 8.2.x or higher
PHP Extensions BCMath, Ctype, cURL, DOM, Tokenizer, Fileinfo, GD, JSON, MBString, OpenSSL, PCRE, PDO, Session, XML

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

info
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 all the files inside the Script 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

Changing the public directory

Configure your web server's document / web root to point to the /public directory of the script. For example, if you've uploaded the script 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 script, login into your user account.
  3. Once logged-in, go to https://example.com/admin and activate your License Key.

Configuration

Cron job

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

Copy the Command field and set up a cron job for it that runs every minute.

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

Some hosting panels might require the cron command in a different format. If needed, you can run it with absolute paths or specific PHP versions:

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1
Useful resources

Email

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

Payment processors

The Admin can add all the payment methods they want and configure their currency and exchange rate from: Admin Payment Methods.

Update

Backing up

warning Before updating the script, you must make a complete backup of your website.

warning If you've made any modifications to the script's files, your changes will be lost.

Updating

  1. Go to the Upgrades folder, select the version you want, click on the README.html file and follow the steps.

FAQ

  • How can I contact support?

    You can contact us here.

  • What type of hosting should I use?

    We recommend using a VPS for better performance, but the script can run on shared hosting without problems.

  • Is installation included in the price?

    No, installation is not included. We offer installation Services for an extra fee.

  • How can I translate my website?

    You can edit the text strings in the folder lang > en and change it according to your needs.

  • Where do I find the HTML template files?

    The HTML template files can be found in the /resources/views folder.

  • Error 404 in the installer

    Check that your .htaccess file has not been corrupted when uploading to your server.

  • Error 500 in the installer or on the home page

    Check that your .env file has not been corrupted when uploading to your server. It must have a dot before the name, and you must have at least PHP 8.2

  • What is the sitemap path?

    The sitemap path is: example.com/sitemaps.xml