GuestLens Install

Start here Step 4 of 7

Install

Installing has two parts. First you put the files on your hosting. Then you open your domain, and an installer in your browser does the rest. These steps use cPanel, which most hosts have. Other panels have the same settings under similar names.

1

Create a database

In cPanel, open MySQL Databases. Create a new database, then create a user with a strong password. Add the user to the database and tick ALL PRIVILEGES. Write down three things: the database name, the user name, and the password.

Most hosts put your account name in front of both names, for example yourname_guestlens. Copy the full names, with that part included.

Using SQLite? Skip this step. The installer creates the database file for you. See Which database to use.
2

Upload the files

Open File Manager in cPanel. Make a new folder for GuestLens next to public_html, for example guestlens. Upload the GuestLens zip into it and use Extract. Then move everything that is inside the script folder up into guestlens, so that guestlens/public and guestlens/artisan exist.

You can also upload with an FTP program such as FileZilla. Upload the contents of script/, not the script folder itself.

3

Point your domain at the public folder

Your domain must open the public folder, not the folder above it. This keeps your settings, your database file, and the uploaded photos out of reach of the web.

Best: change the document root

In cPanel, open Domains, find your domain or subdomain, and set its Document Root to guestlens/public. Most hosts let you do this for an addon domain or a subdomain, such as photos.yoursite.com.

If you cannot: use the web root

Upload the contents of script/ straight into your web root (often public_html). The included .htaccess sends every request into public and refuses everything else. It works, but the first way is better.

Turn on HTTPS for the domain now, before you install. Most panels have a free Let's Encrypt or AutoSSL button. The installer saves your site address, and every QR code is built from it, so it should start with https://.

4

Open your domain and start the installer

Visit your domain in a browser. The installer opens by itself. Check that you have your database details ready, then click Start.

The installer welcome screen, listing what to have ready, with a Start button.
The installer opens on its own the first time anyone visits your domain.
5

Check the requirements

The installer checks your server. Every line is green (fine), orange (it works, but read the note), or red (fix it before you go on). A red line usually means a missing PHP extension or a folder that cannot be written to.

The Requirements step, with green checks for PHP, extensions, and writable folders, and the server upload limits.
Installer, step 1 of 4: Requirements.
  1. The four steps. The current step is dark. Finished steps turn green.
  2. What this server can do: the PHP version, each extension, and each folder GuestLens writes to.
  3. Upload limits: your server's own limits, and the piece size GuestLens will use because of them. Nothing to fix here.
  4. Continue works only when nothing is red.

Fixing a red line: for an extension, see Requirements. For a folder that is not writable, set the folder permission to 755 in File Manager (or 775 if your host asks for it). Then reload the page.

6

Enter your database details

The Database step with the database type, host, port, database name, user, password, and the web address of the site.
Installer, step 2 of 4: Database.
  1. Database type. Choose MySQL or MariaDB, or SQLite. With SQLite, the other fields change to one: where to keep the file. Keep the suggested path, storage/database/guestlens.sqlite.
  2. Your database details from step 1. The host is almost always localhost and the port is 3306.
  3. The web address of this site. Check it now. If your site uses HTTPS, it must start with https://. Every QR code your customers print is built from it.
  4. Test and continue. GuestLens tests the connection first. If it works, it creates its tables. This can take up to a minute.
7

Create your admin account

The Your account step with name, email, password, site name, and time zone.
Installer, step 3 of 4: Your account.
  1. Your name, email, and password. This becomes the super admin account. The password needs at least 10 characters. Use a long one.
  2. Site name. Shown to your customers and their guests. You can change it later under Branding.
  3. Time zone. Pick the zone your events happen in. Hosts type open and close times in this zone. To change it later, edit APP_TIMEZONE in the .env file.
  4. Create my account saves everything and moves to the last step.
8

Copy the cron line, then finish

The last step shows the cron line for your server, with your real folder path already filled in. Copy it now and add it in your hosting panel. The cron job explains how.

The Finish step with the cron command, the web address for URL cron, and the Finish and go to sign in button.
Installer, step 4 of 4: Finish.
  1. The cron line. Use this one if your panel has a normal Cron Jobs page. It does.
  2. The web address for panels that can only open a URL on a schedule. Keep it private.
  3. Finish and go to sign in. This locks the installer and takes you to the sign-in page.
The installer locks itself. When you press Finish, GuestLens writes the file storage/installed.lock and the line GUESTLENS_INSTALLED=true in .env. While either one exists, the /install address shows a Not Found page, so nobody can run the installer again. To reinstall from scratch, delete both and empty the database.

Sign in

Sign in with the email and password from step 7. As the super admin, you land on the admin Overview. Hosts use the same sign-in page and land on their events.

The sign-in card with email, password, keep me signed in, and links to reset a password or create an account.
The sign-in page, at /login.
  1. Email and password.
  2. Keep me signed in on this device.
  3. Forgot your password? sends a reset link by email. Create an account is for new hosts, and you can turn it off. See Settings.

Next: set up the cron job. It takes two minutes.