Tutorial Launch Laramin for your business Step 1 of 11 · Stage 1: Install and sign in. 0 of 10 steps done Exit tutorial

Install Laramin with the web installer

Use the six-step installer in your browser to check your server, create the database, create your administrator account and set up scheduling.

Why this step

Everything else builds on a working install. The installer also sets up the Scheduler (cron): Your server's timer. It runs Laramin's background jobs, like email and backups, every minute. that sends email and runs backups later.

Technical step: it needs server or hosting access. Not you?

Hand this step to your developer

Link to this stephttps://help.laramin.in/en/tutorials/launch-laramin-for-your-business/1

EmailOpens your email app with this message:

Subject: Launch Laramin for your business: step 1

Please do step 1 of “Launch Laramin for your business”: https://help.laramin.in/en/tutorials/launch-laramin-for-your-business/1. Tell me when the checks pass.

Today you only need:

Applies to
Core 12.0 and later
Who can do this
Platform owner
Where
Web installer at /install

The web installer is the usual way to install Laramin on shared hosting. If you have shell access, you can install from the command line instead.

Before you start

  • Upload the built application to your server. The installer needs the front-end assets to be built.
  • Check that your server runs PHP 8.2 or later with these extensions: bcmath, ctype, curl, fileinfo, json, mbstring, openssl, pcre, pdo, tokenizer, zip, gd, xml, dom. The installer checks this for you as well.
  • Have a MySQL 5.7 or 8.x database that is empty. If it doesn't exist yet, the installer can create it, as long as your MySQL user is allowed to.
  • Have your Purchase code and CodeCanyon username ready.
  • Make sure you can add a cron entry on the server, through a shell or a control panel such as cPanel or Plesk.

Steps

The installer has six steps, shown down the left side: Get started, Requirements, Database, Administrator, Scheduling and Finish. You can change the installer's language and switch dark mode from the top bar.

1. Get started

  1. In your browser, open your site's address followed by /install.

  2. In Purchase code, enter your purchase code. It is at least 10 characters long.

  3. In CodeCanyon username, enter your CodeCanyon username.

  4. In the footer, select licence terms.

  5. Scroll to the end of the terms, then select I accept.

  6. Select Continue.

Nothing is written to your database yet. You can stop here and start again later.

2. Requirements

  1. Read the list of checks. Each one is marked Required, Breaks a feature or Optional, and failed checks tell you what to change.

  2. Fix any Required check that fails, then select Re-check.

  3. Select Continue. If only optional checks fail, the button reads Continue anyway.

Tip: This screen never changes anything on your server. You can re-check as often as you need.

3. Database

  1. Enter the Host, Port, Database name, Username and Password of your database.

  2. Only if you need them, open Advanced — table prefix, charset, socket and fill in Table prefix, Character set or Unix socket.

  3. Select Test connection and install.

  4. Keep the tab open while the installer works through its steps: Test the connection, Create the tables, Seed roles, permissions and the module manifests, Record versions, and Write .env — the only step that touches the file.

Careful: Closing the tab stops the run, because each step is requested from your browser. You can reload and start again on an empty database.

If the run stops, see The installer stops at the database step.

4. Administrator

  1. Enter your First name, Last name and Email. Use an inbox that works: it is used for sign-in and password resets.

  2. Enter a Password, then enter it again in Confirm password. It needs at least 12 characters, with upper- and lower-case letters, one number and one symbol. The list of rules under the field doesn't show the letters rule, but Laramin checks it when you create the account.

  3. Select Create account.

This account is the super admin. It bypasses every permission check, so protect it well. You can turn on two-factor authentication right after you sign in.

5. Scheduling

  1. Copy the line under Add this to your crontab. It looks like this, with your own path:

    Plain text
    * * * * * cd /path/to/laramin && php artisan schedule:run >> /dev/null 2>&1

    Replace the highlighted values with your own.

  2. Add the line to your server's crontab so that it runs once a minute. In cPanel, use Cron Jobs → Add New Cron Job. In Plesk, use Websites & Domains → Scheduled Tasks.

  3. Select Check now. It can take up to a minute after you add the entry before you see Cron is running.

  4. Select Continue.

If you can't edit the crontab, the step may show a second line under If you cannot edit crontab. Point an external cron service at that address once a minute.

Careful: You can select Skip for now, but until you add the cron entry nothing scheduled runs: no queued email, no digests and no automatic cleanups.

6. Finish

  1. Read the Before you go live checklist and deal with each item: Confirm the installer is closed, Confirm the cron entry, Serve over HTTPS and Choose your languages.
  2. Select Go to the admin.

Tip: The administrator you create here is the only super admin on a new installation. Its password must be at least 12 characters, with upper- and lower-case letters, a number and a symbol, and must not appear in known data breaches.

What happens next

When you finish, /install stops opening. Sign in with the administrator account you created. See Sign in for the first time.

Check it worked

0 of 2 ticked

Tick each one you can see. Ticks stay on this device; they don't stop you moving on.

Check it worked

Something not right? The installer stops at the database step

Steps
Mark done