Installation

Install Adminix with Composer.

composer require alex-kudrya/adminix

Adminix requires PHP >=8.2 with PDO, mbstring, and SimpleXML extensions.

Laravel auto-discovers the package service provider through Composer. Add the provider manually only if package auto-discovery is disabled in your application.

// config/app.php

'providers' => [
    // ...
    \AlexKudrya\Adminix\Providers\AdminixServiceProvider::class,
    // ...
]

Publish the package config and assets with the installer command.

php artisan adminix:install

Use --examples when you want to publish example page providers, and --force when published files must be overwritten.

php artisan adminix:install --examples

You can still publish each group manually.

php artisan vendor:publish --provider="AlexKudrya\Adminix\Providers\AdminixServiceProvider" --tag=config

Publish Adminix assets.

php artisan vendor:publish --provider="AlexKudrya\Adminix\Providers\AdminixServiceProvider" --tag=laravel-assets

The laravel-assets tag publishes Adminix CSS, fonts, runtime JavaScript, and CKEditor 5 runtime files needed by the package views. It does not publish CKEditor samples or non-runtime CKEditor documentation into the consuming app's public directory.

Optionally publish example page providers.

php artisan vendor:publish --provider="AlexKudrya\Adminix\Providers\AdminixServiceProvider" --tag=examples

Authorization

Skip this section only if you explicitly allow access without authorization by setting no_auth_access to true. Do not enable no_auth_access in production.

Run migrations.

php artisan migrate

Add the AdminixUser trait to your user model and implement AdminixUserInterface. Usually the model is App\Models\User.

// app/Models/User.php

namespace App\Models;

use AlexKudrya\Adminix\AdminixUser;
use AlexKudrya\Adminix\AdminixUserInterface;

class User extends Authenticatable implements AdminixUserInterface
{
    use AdminixUser;

    // ...
}

In config/adminix.php, make sure that admin_user_model points to your user model.

// config/adminix.php

return [
    'route_prefix' => env('ADMINIX_PREFIX', 'adminix'),

    'admin_user_model' => \App\Models\User::class,

    'pages' => [
        // Add Adminix page providers here.
    ],

    'menu' => [
        'title' => 'AdminiX',
        'links' => [
            // Add menu links here.
        ],
    ],

    'app_title' => 'My admin panel title',

    'no_auth_access' => false,
];

Robots.txt

Optionally disallow indexing Adminix pages for search engines in robots.txt.

User-agent: *

Allow: /
Disallow: /adminix

After installation, configure the pages and menu of your admin panel. For production projects, also review Security.

Last modified: 23 June 2026