Installing

Installing takes a few minutes: upload the files, create a database, and let the installation wizard do the rest.

Before you start

• Check the requirements.
• Create an empty database and a database user in your hosting panel, and note the database name, user and password.
• If you can, get an SSL certificate for the domain first (most panels issue a free Let's Encrypt certificate on their own). The wizard then records the site address with https://.
• If the domain's DNS is on Cloudflare, keep Qorekit's record DNS only (the grey cloud), not proxied. Behind a proxy, Qorekit sees the proxy's address instead of each visitor's, so limits such as sign-in attempts per address count many visitors together, and some hosts' firewalls block the proxy's requests now and then.

1. Upload the files

Download the latest release, qorekit-<version>.zip. It holds one folder, qorekit/.

In your hosting panel's file manager, upload the zip to the folder the domain serves (on most shared hosting, public_html, or domains/<domain>/public_html on DirectAdmin), extract it there, and move the contents of the qorekit/ folder up into the served folder. Delete the zip and any default page the host put there, such as index.html. Leave a .well-known folder alone, if there is one: certificates need it.

You should now see app, public, vendor, index.php, .htaccess and other files directly in the served folder.

Where to put the files

Qorekit works in two ways:

The whole package in the served folder (Apache and LiteSpeed, which most shared hosting uses). The .htaccess file at the top sends every request to the application and keeps Qorekit's own files, such as .env, out of reach. A sub-folder such as public_html/crm works too.

The domain pointed at the public/ folder, if your panel lets you choose the document root. This is the cleanest setup, and with nginx it is required, since nginx does not read .htaccess files.

After installing, Administration › System checks that Qorekit's own files cannot be downloaded, and warns you if they can.

2. Run the installation wizard

Open the site address in a browser. The wizard has three steps.

Server check. Qorekit checks PHP, its extensions and write permissions. If something required is missing, it says what; your hosting provider can help.

Database. Choose MySQL or MariaDB or PostgreSQL and enter the host (usually localhost), port, database name, user and password. A table prefix is optional; it lets Qorekit share a database with other programs. The database must be empty, or have no tables with that prefix.

Site and administrator. The site name, the site address, the default language and time zone, and your administrator account: your name, email and a password of at least 8 characters.

Install creates the tables and your account and writes .env. If something stops it part way, run the wizard again: it picks up where it left off.

3. After installing

1. Sign in with the administrator account.
2. Add the cron job: see scheduled work (cron). Qorekit works without it, but scheduled work then waits for people to use the site.
3. Open Administration › System and check that nothing needs attention.
4. Turn on your panel's redirect from http to https, if it has one (Force SSL in DirectAdmin, Force HTTPS Redirect in cPanel's Domains).

If the site address is wrong

If you installed before the certificate was ready, or moved the site, change APP_URL in .env to the new address, such as https://crm.example.com.

Installing from a hosting panel's app installer

Hosting panels with an app installer, such as Softaculous or Installatron, can install Qorekit with a few clicks once they list it. The panel asks for the site name, the administrator account and the database, and the installation finishes on the first visit to the site.

Installing from the command line

With SSH access, the same installer runs without a browser:

php artisan qorekit:install --url=https://crm.example.com \
    --db-connection=mysql --db-host=localhost --db-database=crm --db-username=crm --db-password=... \
    --admin-name=Ada --admin-email=ada@example.com --admin-password=...

php artisan qorekit:install --help lists every option, including --db-prefix, --name, --language and --timezone.