Installation

This guide is focusing on installation on a local machine; we assume you have a complete development environment setup for Laravel applications. If not, then check out recommended development environments. To deploy to a real production ready server, check out the deployment guides in the menu.

Prerequisite

Local development environment with MySql 5.7, PHP 7.3 with all required extensions installed and running.

Git

It's recommended that you use git . as a part of your install & deploy strategy with LaraOne CMS. With git you will clone LaraOne CMS directly from github.com. Start by cloning out the below link into a folder of your choice. Inside a directory where you want to have the cms run this command:

    git clone https://github.com/laraone/laraone

Composer

You will need to have access to php package manager Composer . Install composer if it's not already on your machine. Inside the same folder where you cloned the LaraOne backend, run this command:

    composer install

This command will install all package dependencies both Laravel Framework and LaraOne CMS have together.

Env file

Copy and then rename .env.example into .env

Note: .env file is used by Laravel applications and is neccessary for LaraOne CMS to run correctly.

Create a database

Before we install the CMS you need to create a database. We suggest you name it laraone.

Installation

There are two ways to install the CMS. One is from CLI by running a simple artisan install command, and the other is by running a graphical install wizard directly from the browser. We'll show you both ways below. CLI is for developers who want to install directly from the command line while install wizard is for everyone who prefers to do it directly through the browser.

Install Wizard

After completing the steps above, assuming you have already setup a local domain pointing to a folder where you installed the cms, visit

    http://local-domain.test/installation

Note: Replace local-domain.test with your own local domain that points to LaraOne folder.

Note: Most local environments for PHP applications come with a feature to automagically give you links for any folders you create under /www folder, links like myapp.dev or myapp.test

Imporant: When using the Install Wizard, LaraOne will always be put in production mode independent of what is set in .env file. This is done for security reasons, so that less experienced developers and non-developers would not by misstake deploy the CMS with application environment set to local while installing on a live server. When installing from CLI, install process will respect environment that is set in .env file.

Once you visit local domain, you will be met by this screen.

First Steps asks you to provide database information. Provide the information for your own local environment.

Provide website title, pick a user name, provide the email address and a password.

Installation will take few moments depending on how fast your machine is. If everything goes well, you should be met by this screen.

If you reach this screen installation has been successful, click on the "Go to Login" button and now you can login into your local website.

Install via CLI

Installing from command line interface is simple. There are two cases to be considered when installing via CLI.

  • Application Environment is set to local, done when playing with CMS on your local machine.
  • Application Environment is set to production, done when installing the CMS on a real server or local machine while developing.

Local Environment

Before installing the CMS make sure that application environment is set to local by opening .env file

    APP_ENV=local

Then run

    php artisan laraone:install

Installation will take few moments. After successful installation you will have three users that you can login with. Three users with different levels of access and permissions.

    super@gmail.com -> super user with access to everything
    admin@gmail.com -> admin user with access to almost everything
    member@gmail.com -> only allowed to post comments on the frontend, can't access admin area

All three users have the same password: 12345678

Important: When APP_ENV is set to local, the install command will create three dummy users for you to play with. Unless you know what you are doing, do not set APP_ENV to local on a live server just before installing the CMS. Only set it to local if you are experienced and know what you are doing.

Production Environment

Make sure that application environment is set to production by opening .env file

    APP_ENV=production

When installing the CMS via CLI in a production environment, you will not get any dummy users. You will have to specify the admin user via .env file.

Uncomment these lines

    ADMIN_USERNAME=my_username
    ADMIN_EMAIL=my_email@gmail.com
    ADMIN_PASSWORD=password_with_minimum_8_characters
    ADMIN_FIRSTNAME=firstname
    ADMIN_LASTNAME=lastname

First name and last name are optional; you can leave them commented out if you do not want them displayed on the website.