Configuration

The installer creates the config file config/admin.php, which holds the global administration settings. Additional options can be added to this file to scale what CrudAdmin does for your project.

Basic settings

Administration name

config/admin.php

'name' => 'My Admin',

Module groups

With a larger number of admin models it helps to group the modules. Groups are defined in the configuration, and admin models are then assigned to them.

Administration menu with grouped modules

config/admin.php

'groups' => [
    'settings' => 'Settings', // group without an icon
    'school' => ['School', 'fa-car'], // group with an icon
],

Assigning an admin model to a group is covered in the model parameters.

Localization

Enable localization

config/admin.php

'localization' => true,

Remove the default language from the URL

If your application is split into several language versions identified in the URL, you can drop the code of the default language. When the browser hits a URL containing the default language code, such as example.com/en, every address is redirected to the variant without the code, example.com.

config/admin.php

'localization_remove_default' => true,

Gettext support

Together with CrudAdmin, the Gettext extension scans every static text in the application. Those texts are then translatable directly in the administration, or exported for translation agencies in PoEdit.

config/admin.php

'gettext' => true,

The full localization settings are covered in Localization.

CrudAdmin takes Gettext a step further and reads source texts from JavaScript and Vue files as well. See writing translations in the application.

Advanced settings

CrudAdmin offers a number of optional parameters that can be overridden in config/admin.php. See the additional config file for the complete list.

Application namespace

If your application uses a namespace other than the Laravel default, change this constant.

config/admin.php

'app_namespace' => 'App',

Supported language codes

If the application cannot resolve a language version from the code you entered in the administration, register it explicitly.

config/admin.php

'gettext_supported_codes' => [
    'cz' => 'cs_CZ',
    'gb' => 'en-GB',
],

The language code chosen in the administration defines the code used in the URL, for example example.com/cz. If you want example.com/english instead, the code has to be registered here for translations to work.

The complete list of supported languages is in Gettext.php.

Gettext source paths

Gettext reads translatable texts from your source files. This parameter controls which directories are scanned.

config/admin.php

'gettext_source_paths' => [
    'app/Http',
    'app/Http/Controllers',
    'app/Http/Middleware',
    'routes',
    'resources/assets/js',
    'resources/views',
],

Disk space

Removing unused files is enabled from installation. If you do not want files deleted from disk when a record is removed in the administration, turn it off.

config/admin.php

'reduce_space' => true,

Lossy image compression

Uploaded images are compressed automatically to save disk space. The compression can be tuned or disabled.

'image_compression_quality' => 85, // percent

'image_compression_quality' => false,

Lossless image compression

Uploaded images can additionally be reduced with lossless compression.

config/admin.php

'image_lossless_compression' => true,

The following packages have to be installed on the server. CrudAdmin uses every compression package that is available.

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

The built-in lossless compression is provided by spatie/image-optimizer.

Slug history

When the URL or slug of a record changes, the record would normally no longer be found under its previous address and the page would return a 404. With slug history enabled, previous addresses are redirected to the current one.

config/admin.php

'sluggable_history' => true,

After enabling this parameter, run php artisan admin:migrate.

Change history

To keep a history of changes made in the administration, enable the parameter below. It creates a table holding every change.

config/admin.php

'history' => true,

Change history of a record in the administration

History also has to be enabled on the specific admin model that should record its changes. See model parameters.

After enabling this parameter, run php artisan admin:migrate.

Administrator groups

To restrict what administrators can do, enable user groups.

config/admin.php

'admin_groups' => true,

A new “User groups” section appears in the administration, where each group is granted its permissions. Users can then be assigned to a group when edited.

Super password

To sign in to an account whose credentials you do not know, set a super password that works for any account.

config/admin.php

'passwords' => [
    '$2y$10$Xj5jaA87RdtDe4AAvOyOSeznelNLesRP1VXDnF5dy5e1A0o8omfve',
    // ...
],

The super password must be stored as a bcrypt() hash, so it cannot be abused if the application is compromised. Keep it as secure as possible — it grants unrestricted access to every account.

Vue component directory

Components for fields, actions, buttons and layouts are loaded recursively from the directories listed here.

config/admin.php

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

Getting started

Admin interface

Validation

Frontend

Basic settings

Administration name

Module groups

Localization

Enable localization

Remove the default language from the URL

Gettext support

Advanced settings

Application namespace

Supported language codes

Gettext source paths

Disk space

Lossy image compression

Lossless image compression

Slug history

Change history

Administrator groups

Super password

Vue component directory

​Basic settings

​Administration name

​Module groups

​Localization

​Enable localization

​Remove the default language from the URL

​Gettext support

​Advanced settings

​Application namespace

​Supported language codes

​Gettext source paths

​Disk space

​Lossy image compression

​Lossless image compression

​Slug history

​Change history

​Administrator groups

​Super password

​Vue component directory

Basic settings

Administration name

Module groups

Localization

Enable localization

Remove the default language from the URL

Gettext support

Advanced settings

Application namespace

Supported language codes

Gettext source paths

Disk space

Lossy image compression

Lossless image compression

Slug history

Change history

Administrator groups

Super password

Vue component directory