Tutorial

Launch Laramin for your business

Go from an empty server to a Laramin your team can use safely. You'll install it, add your business details and send email. Then you'll bring your team in and back up every day.

  • Beginner
  • About 2 hours
  • 4 stages, 10 steps + 1 optional
  • For platform owners and administrators
  • Core 12.7 and later
Start the tutorial

First step: Install Laramin with the web installer · 25 min Your progress is kept on this device. No sign-in needed.

Step 1 needs server access. Not technical? You can hand it to your developer.

You'll be able to

  1. Install Laramin and sign in as its first administrator.
  2. Set your business details, time zone and currency, and send email that arrives.
  3. Explain how workspaces, teams and experiences decide what each person sees.
  4. Give your team access with roles that fit their jobs.
  5. Protect your installation with sign-in rules and automatic backups.

These become your checklist. Each one is ticked on the last page, when you finish the tutorial.

Before you start

5 things to have ready

Have these ready. You don't need them all today: each one says which step needs it.

  • A server or hosting account with PHP 8.2 or later and a MySQL database. Have the database name, user and password. Needed for step 1
  • Access to your server's scheduled tasks (cron, your server's timer). Your hosting company can tell you where it is. Needed for step 1
  • Your email provider's sending details (they call it SMTP; your email company can give them to you). Needed for step 4
  • The names and email addresses of 1 or 2 colleagues to add. Needed for step 7
  • Somewhere outside your server to keep copies, such as Amazon S3. Your hosting company can suggest one. Needed for step 10

Not technical? Step 1 needs server access, and has a Hand this step to your developer button with a message ready to send.

What you'll have at the end

Every stage ends with something that works:

The 4 stages

About 2 hours in all. Each stage ends with a short recap. Stop whenever you like: your progress stays on this device.

Stage 1 · About 35 min

Stage 1: Install and sign in

To do
About 35 min

Goal: Laramin running on your server, and you signed in as its owner.

Key terms: Web installer: A few screens in your browser that install Laramin for you. Scheduler (cron): Your server's timer. It runs Laramin's background jobs, like email and backups, every minute. Super admin: The first account, which can change everything.

  1. To do: Install Laramin with the web installer Guide Technical 25 min
  2. To do: Sign in for the first time Guide You 10 min
Stage 2 · About 25 min

Stage 2: Make it yours

To do
About 25 min

Goal: Laramin shows your business details and can reach people by email.

Key terms: Company settings: Your business name, contact details, address and opening hours. Time zone: The local time Laramin uses to show and store dates and times. Delivery provider: The service that actually sends Laramin's emails, such as your email host or AWS SES.

  1. To do: System and company settings Reference You 10 min
  2. To do: Connect an email provider Guide You 15 min Needs Notification Manager

    Have ready: your email provider's sending details.

Stage 3 · About 35 min

Stage 3: Bring your team in

To do
About 35 min

Goal: Your colleagues can sign in and see only what their job needs.

Key terms: Workspace: One business inside Laramin, such as Ambrovale Realty. Team: A group of people inside one workspace. Experience: How Laramin is arranged for someone: its menu, layout and home page. Role: A named set of permissions for one job, such as Sales.

  1. To do: Create a role and assign permissions Guide You 10 min Needs Roles & Permissions
  2. To do: Create a user Guide You 10 min
  3. To do: Create a team and add members Guide You 10 min
Stage 4 · About 25 min, plus 10 optional

Stage 4: Keep it safe

To do
About 25 min, plus 10 optional

Goal: Sign-in is protected and a copy of your data leaves the server every day.

Key terms: Session: How long someone stays signed in before Laramin asks again. Lockout: A pause on signing in after too many wrong passwords. Backup destination: The place outside your server where backup copies are kept.

  1. To do: Security settings Reference You 10 min
  2. To do: Schedule backups to cloud storage Guide You 15 min Needs Backup

    Have ready: your storage provider's details.

  3. To do: Connect your installation to the Help Center Guide You 10 min Optional

Reset your progress in this tutorial?

Your ticks and checks on this device are cleared. This can't be undone.