Voyager is super easy to install. After creating your new Laravel application you can include the Voyager package with the following command:
$ composer require tcg/voyager
Next make sure to create a new database and add your database credentials to your .env file:
DB_HOST=localhost DB_DATABASE=homestead DB_USERNAME=homestead DB_PASSWORD=secret
You will also want to update your website URL inside of the
APP_URL variable inside the .env file:
Next, add the Voyager service provider to the
config/app.php file in the
'providers' => [ // Laravel Framework Service Providers... //... // Package Service Providers TCG\Voyager\VoyagerServiceProvider::class, // ... // Application Service Providers // ... ],
Finally, we can install Voyager. You can choose to install Voyager with dummy data or without the dummy data. The dummy data will include 1 admin account (if no users already exist), 1 demo page, 4 demo posts, 2 categories and 7 settings.
To install Voyager without dummy data simply run
php artisan voyager:install
If you prefer installing it with the dummy data run
php artisan voyager:install --with-dummy
Specified key was too long error. If you see this error message you have an outdated version of MySQL, use the following solution: https://laravel-news.com/laravel-5-4-key-too-long-error
And we're all good to go!
Start up a local development server with
php artisan serve And, visit http://localhost:8000/admin.
If you installed with the dummy data, a user has been created for you with the following login credentials:
NOTE: Please note that a dummy user is only created if there are no current users in your database.
If you did not go with the dummy user, you may wish to assign admin priveleges to an existing user.
This can easily be done by running this command:
php artisan voyager:admin email@example.com
If you wish to create a new admin user you can pass the
--create flag, like so:
php artisan voyager:admin firstname.lastname@example.org --create
And you will be prompted for the users name and password.