Configuration

The config file

The installer publishes config/admin.php with the most common keys. Every other key described on this page has a package default, add it to config/admin.php only when you want to change it. Values from config/admin.php always win over the package defaults.

Config cache

php artisan optimize and config:cache work with CrudAdmin, the packages are not merged again on top of a cached config. See Deployment.

Config files do not support closures (function () {}, fn () =>), config:cache fails on them. Where a value has to be resolved per request, use a [Class::class, 'method'] callable of a static method; the logo, the groups of a package and admin_helpers.auth.otp.user accept it.
Call env() only in config files. With a cached config env() returns null everywhere else, read the value through config().
php artisan admin:upgrade:cache of crudadmin/upgrade lists the closures in config files and the env() calls outside them.

Basic settings

Administration name

Shown in the page title, and used as a text logo when no logo is set.

config/admin.php

'name' => env('APP_NAME', 'My Admin'),

Module groups

With a larger number of admin models it helps to group the modules. Groups, their names, icons and the order of the whole menu are declared in the navigation section of bootstrap/admin.php, not in config/admin.php.

Administration menu with grouped modules

The groups config key of older versions is moved there by php artisan admin:upgrade:navigation. Packages still merge their groups into config('admin.groups'); such a group is used when the navigation section does not name it, and a group key without any definition is displayed as its key.

Branding

config/admin.php

'appearance' => [
    // text, image URL, public path, [default, small] or a [Class::class, 'method'] callable
    'logo' => [App\Admin\Branding::class, 'logo'],

    'author' => false,

    'copyright' => [
        'name' => 'Example Agency',
        'website' => 'https://example.com',
        'since' => 2020,
    ],

    'primary_color' => '#0d6efd',

    'styles' => [
        'build/assets/admin.css',
    ],

    // loaded for logged administrators, as module scripts by default
    'scripts' => [
        'build/assets/admin.js',
        ['src' => 'https://cdn.example.com/legacy.js', 'module' => false],
    ],

    // blade file path or the name of a global Vue component
    'dashboard' => 'Dashboard',
],

Without appearance.dashboard, resources/views/admin/dashboard.blade.php is rendered when it exists. Registering Vue components from your scripts is described in Vue app.

License key

config/admin.php

'license_key' => 'your-license-key',

See License.

Authentication

config/admin.php

'auth' => [
    'login' => [
        'column' => 'username',
        'title' => 'Sign in with your username',
        'username' => 'Username', // placeholder of the login input
        'path' => '/login',       // guests and logged out administrators are redirected here
    ],

    // select the authentication provider automatically on login
    'autoprovider' => true,
],

Application namespace

Root namespace and class name of the admin auth model, used by admin:install and when resolving the auth model. Where models are loaded from is set by models.

config/admin.php

'app_namespace' => 'App',

'auth' => [
    'eloquent' => 'Admin',
],

Administrator roles

Enables user groups with permissions per module, see Permissions.

config/admin.php

'auth' => [
    'roles' => true,
],

Admin::isRolesEnabled() returns the value of the key. Without roles every administrator has full access.

Localization

Language versions and Gettext are configured with the localization and gettext groups, and with locale. See Localization.

Models and components

Model and module directories

Admin models are discovered in App, App\Model, App\Models and App\Eloquent. Global model modules are loaded from app/Admin/Modules and applied to every model.

config/admin.php

'models' => [
    'App\Models' => app_path('Models'),
    'Domain\Catalog\Models' => base_path('domain/Catalog/Models'),
],

'modules' => [
    'App\Admin\Modules' => app_path('Admin/Modules'),
],

Directories are scanned recursively, except app_path() itself.

Vue component directory

Components for fields, buttons, columns and layouts are loaded recursively from the listed directories. Relative paths are resolved from the project root, and the package components directory is always added.

config/admin.php

'components' => [
    'resources/views/admin/components',
],

A component can be referenced in several ways:

Reference	Resolved file
`OrderStats` or `OrderStats.vue`	`OrderStats.vue` in a configured directory, or found by its file name in any subdirectory (case insensitive)
`orders/OrderStats.vue` or `orders.OrderStats`	`orders/OrderStats.vue` in a configured directory
`/var/www/app/resources/js/OrderStats.vue`	absolute path
`admin/components/OrderStats.vue`	path relative to `resources/views`

Buttons also look into resources/views/admin/components/buttons, layouts into .../layouts and field components into .../fields. For a comma separated list of field components, every existing component is loaded and missing ones are skipped.

The <style> block of a component is dropped. Put component CSS into a global stylesheet, see branding.

Field rule aliases

custom_rules expands a field parameter into other parameters, global_rules adds parameters to every field of a type. Application values override the package ones.

config/admin.php

'custom_rules' => [
    'money' => 'type:decimal|min:0',
],

'global_rules' => [
    'phone' => 'max:30|placeholder:+421',
],

'price' => 'name:Price|money',

Parameters of an alias override parameters written on the field, while parameters written on the field win over global_rules.

Default form autocomplete

Default autocomplete attribute of form inputs in all models, off by default. A model can change it with the form.autocomplete setting.

config/admin.php

'model' => [
    'settings' => [
        'form' => ['autocomplete' => 'on'],
    ],
],

Uploads and images

Uploads disk

config/admin.php

'storage' => [
    'disk' => env('FILESYSTEM_DRIVER_CRUDADMIN', 'crudadmin.uploads'),
],

Admin::getUploadsStorage() returns the uploads disk, Admin::getUploadsStorage(true) the private uploads disk.

Disk space

Files of deleted records and files replaced by a new upload are deleted from the disk. Set false to keep them. A model can keep its files with $deleteFiles = false.

config/admin.php

'storage' => [
    'reduce_space' => true,
],

Upload filenames

Files with the same name get -1, -2 suffixes. With the postfix enabled, a random suffix is added instead, which avoids existence checks on remote disks.

config/admin.php

'storage' => [
    'postfix' => true, // photo_Xr4kQ9bT2m.jpg
],

Images

config/admin.php

'images' => [
    // Downsize uploaded images larger than the limits, keeping the ratio. false disables one limit.
    'auto_resize' => true,
    'max_width' => 3840,
    'max_height' => 2160,

    // JPEG quality in percent after upload and after every resize, true means 85
    'lossy_quality' => 85,

    // Shell optimizers after upload
    'lossless' => true,
],

Models can override every value, see image compression. Lossless compression uses spatie/image-optimizer with every optimizer available on the server:

sudo apt-get install jpegoptim optipng pngquant gifsicle
sudo npm install -g svgo

WebP copies

Every resized image also gets a .webp copy stored next to it.

config/admin.php

'images' => [
    'webp' => true,
],

Resized images

config/admin.php

'images' => [
    'resizer' => [
        // false - local cache, true - the disk of the uploads, string - custom disk name
        'storage' => false,
        // cache existence of resized files on remote disks
        'storage_cache' => true,
        'storage_cache_days' => 31,
        'redirect_after_resize' => true,
    ],

    // image used when the source image of a resize is missing
    'backup' => public_path('images/placeholder.jpg'),

    // false disables resizing, resize() and image() return the original file
    'rewrite_missing' => true,
],

Change history

Enables the change history. Models record their field changes only with $history = true.

config/admin.php

'history' => [
    'enabled' => true,

    // also log deletes, publishing, views and sign-ins of every model, false keeps only data changes
    'actions' => true,
],

After enabling history, run php artisan admin:migrate.

Admin::isHistoryEnabled() returns the state of the switch.

Editor

File browser

File browser of the editor field.

config/admin.php

'filemanager' => [
    'type' => 'ckfinder', // none | lfm | ckfinder
    'license_name' => 'www.example.com',
    'license_key' => env('CKFINDER_LICENSE_KEY'),
],

lfm requires composer require unisharp/laravel-filemanager.
ckfinder is a commercial package downloaded by php artisan editor:ckfinder:download, licensed per hostname. The license is never sent to the browser.

Use only the filemanager array. Old boolean settings were removed in v6; see the upgrade guide.

Optional modules

Frontend editor

Available with the crudadmin/website package (composer require crudadmin/website).

Lets administrators edit static texts, images and links directly on the website. Editable images and links are rendered with the uploadable() and linkable() helpers. See Frontend editor.

config/admin.php

'frontend_editor' => [
    'enabled' => true,
    'stateless' => false, // true serves editor routes from the api
],

// extensions of non image files accepted by the editor
'storage' => [
    'allowed_extensions' => 'pdf,doc,docx,xls,xlsx,zip',
],

Site tree

Available with the crudadmin/website package (composer require crudadmin/website).

Enables the site tree module, where administrators build the website navigation from routes and model records. See Site tree.

config/admin.php

'sitetree' => true,

Slug history and SEO

Slug history (history.sluggable) and SEO of routes (the seo group, available with crudadmin/website) are described in Pretty URLs and SEO.

REST API

Requests to the REST API of the crudadmin/api package are logged by default. max_per_page limits the per_page parameter of the rows list.

config/admin.php

'api' => [
    'logging' => false,
    'max_per_page' => 100,
],

Getting started

Upgrade guide

Admin interface

Validation

Frontend

Website

The config file

Config cache

Basic settings

Administration name

Module groups

Branding

License key

Authentication

Application namespace

Administrator roles

Localization

Models and components

Model and module directories

Vue component directory

Field rule aliases

Default form autocomplete

Uploads and images

Uploads disk

Disk space

Upload filenames

Images

WebP copies

Resized images

Change history

Editor

File browser

Optional modules

Frontend editor

Site tree

Slug history and SEO

REST API

Localized routes

​The config file

​Config cache

​Basic settings

​Administration name

​Module groups

​Branding

​License key

​Authentication

​Login

​Application namespace

​Administrator roles

​Localization

​Models and components

​Model and module directories

​Vue component directory

​Field rule aliases

​Default form autocomplete

​Uploads and images

​Uploads disk

​Disk space

​Upload filenames

​Images

​WebP copies

​Resized images

​Change history

​Editor

​File browser

​Optional modules

​Frontend editor

​Site tree

​Slug history and SEO

​REST API

​Localized routes

The config file

Config cache

Basic settings

Administration name

Module groups

Branding

License key

Authentication

Login

Application namespace

Administrator roles

Localization

Models and components

Model and module directories

Vue component directory

Field rule aliases

Default form autocomplete

Uploads and images

Uploads disk

Disk space

Upload filenames

Images

WebP copies

Resized images

Change history

Editor

File browser

Optional modules

Frontend editor

Site tree

Slug history and SEO

REST API

Localized routes