Getting started

Installation

Install Qorex OS with the web installer. It takes about five minutes.

Before you start#

Create an empty MySQL or MariaDB database and a user with full rights to it. Note the host, database name, username and password.
Have your CodeCanyon purchase code ready. You need it right after installation to activate.

Step by step#

Unzip the download on your computer. Upload the contents of the application folder to your server (for example into public_html, or a folder of its own).
Point your domain or sub-domain to the public folder. If your host cannot do this, upload to the web root and keep the supplied .htaccess files in place.
Open https://your-domain.com/install in your browser.
Step 1 – Server check. The installer lists every requirement and folder permission. Fix any red item and reload. Continue when everything is green.
Step 2 – Database. Enter the database host, name, username and password. The installer tests the connection before it continues.
Step 3 – Business and administrator. Enter your business name and the name, email and password of the administrator who will sign in first.
Step 4 – Install. The installer creates the database tables, loads the default roles and permissions, and writes the .env file. Wait until it finishes.
Add the cron job (below), then sign in and activate your licence.

Note

When installation finishes the installer switches itself off and refuses to run again on a live site, so it can never overwrite your settings. If an installation fails part-way you can reopen /install and retry from the same browser session.

Add the cron job#

Qorex runs reminders, scheduled reports, automatic backups, licence checks, data clean-up and other background work from one scheduler. In your hosting control panel add a cron job that runs every minute:

* * * * * /usr/bin/php /path/to/qorex/artisan schedule:run >> /dev/null 2>&1

Replace /usr/bin/php with the path to PHP 8.2 on your server, and /path/to/qorex with the folder that contains the artisan file. You can switch each task on or off, change its schedule, and run it by hand under Settings → System configuration.

Important

Without the cron job nothing scheduled runs: instalment reminders, scheduled reports, automatic backups, update notices and the nightly data clean-up all depend on it.

After installation#

Sign in with the administrator you created.
Activate your licence. The activation screen opens by itself when needed.
Follow the quick-start.
Turn on two-factor sign-in for administrators and set your password policy. See security.

Moving or re-installing#

To move to a new server, take a backup of the database and of the storage and .env files, upload the files to the new server, import the database and point the domain. Then move your licence to the new domain from Settings → License & updates.