Getting started

New installation

On this page

An empty database, the install package and install.php: about ten minutes. Check Requirements first if you are not sure about your hosting.

The two packages

FileUse it for
…-install.zipA new site. It holds everything, including install.php.
…-update.zipA site that already runs. The same files without install.php, so unzipping it over a live site can never offer to install over your data. See Updating to a new version.

Neither package carries config.php, installed.lock or uploads/. Those belong to your site alone.

1. Create the database

In cPanel open MySQL® Databases (or the MySQL Database Wizard). Create a database, create a user with a strong password, and add the user to the database with All Privileges. cPanel puts your account name in front of both, for example cpaneluser_dms. Write down the database name, the user and the password.

2. Upload the files

Open File Manager, go to the folder the address points at (public_html, a sub-domain's folder, or a folder inside one), Upload the install zip and Extract it. Check that index.php, install.php and the admin folder now sit directly in that folder.

3. Run the installer

Open https://your-domain/install.php. Any page of a site that is not installed yet sends you there by itself.

Server requirements

The first card lists eight checks with a tick or a cross. Five are required: PHP 8.0 or newer, PDO MySQL driver, mbstring extension, JSON extension and Root folder writable. If one of them fails, the page says Some required items are missing. Please fix them and reload this page. and shows no form. cURL, ZipArchive and uploads/ are shown for information. The installer creates uploads/ itself when it is missing.

Configuration

Three cards and one button.

Database

  • Database host: localhost on cPanel.
  • Port: 3306.
  • Database name, Database user, Database password: the three values from step 1.

Site

  • Site name: shown in the panel, in the browser tab and on e-mails.
  • Company name: your business, for example Shruti Hearing Solutions Ltd.. Left empty, the site name is used.
  • Site URL: already filled in with the address you opened the installer at. It works on a domain, a sub-domain or a folder. Use https:// when the site has a certificate.
  • License server URL: leave it as https://license.faruk.bd.

Administrator account

  • Full name, E-mail and Password (at least 6 characters). This becomes the first Super Admin, the one account that can do everything. The e-mail is also used as the company e-mail and as the sender of outgoing mail until you change them.

Press Install now.

If you seeDo this
Database connection failed: …A typo in the name, user or password, or the user was never added to the database.
Could not write config.php. Give the folder write permission (755) and try again.Fix the folder permission in File Manager and press Install now again.
Administrator name, a valid e-mail and a password of at least 6 characters are required.Fill in the third card completely.

What the installer does

  • Creates the tables from database/schema.sql.
  • Creates five roles (Super Admin, Administrator, Manager, Staff, Dealer) and makes your account Super Admin.
  • Saves the default settings: BDT and Tk, the Asia/Dhaka time zone, the numbering prefixes INV, DLR, TKT, WR and CLM, and a fresh cron key.
  • Copies the faruk.bd logo and icon into uploads/logos/ as a starting logo. Replace them with your own on day one.
  • Registers every addon in plugins/. The free ones are switched on at once: Dealer Network, Warranty & Guarantee, Discount & Coupon, Data Export & Import and Languages. The premium ones are listed but stay off until your licence carries them.
  • Writes config.php (the database details, the site address and a secret key, saved without a BOM) and installed.lock.
  • Creates the tables of the addons it switched on. If that last part fails, the page tells you so: sign in and open db_update.php to finish it.

4. The finish page

Installation complete, followed by three steps:

  1. Secure the installation: delete install.php from the server.
  2. Create your license account: Create your account on the license server or I already have an account. Your key, renewals, premium addons and support all live there.
  3. Activate this domain: Sign in and activate or View the front page. Under it is the cron command with the real path of your server. Copy it now; Scheduled jobs (cron) explains it.

5. Delete install.php

Delete it in File Manager. installed.lock already stops it from running a second time (it sends the visitor to the front page), but a live site has no use for it.

6. First sign-in

Open https://your-domain/admin/login.php, or press Admin login on the front page. Enter your E-mail address and Password and press Sign in.

The first screen is Activate your license. The admin panel and the dealer portal stay locked until a key is activated; the public front page works already. Paste your key and press Activate this domain. Everything about keys is in The licence key and addon keys, and the tour of the panel is in The admin panel - first steps.

Dealers sign in at https://your-domain/dealer/login.php (Dealer login on the front page).

Keep config.php safe

config.php holds the database password. Leave it at permission 644 and never send it to anyone. If you ever edit it, use the cPanel File Manager editor or a plain-text editor that saves UTF-8 without BOM; Troubleshooting explains why.

Chat with Faruk
Faruk's Assistant Online — AI Powered