Configuration
=============

.. note::

    This page will be removed soon, as it's content is being improved and moved to
    other pages of the documentation. Please refer to each section's documentation for up-to-date
    information on SonataAdminBundle configuration options.

Configuration
-------------

Configuration options

.. code-block:: yaml

    # config/packages/sonata_admin.yaml

    sonata_admin:
        security:

            # the default value
            handler: sonata.admin.security.handler.role

            # use this service if you want ACL
            handler: sonata.admin.security.handler.acl

Full Configuration Options
--------------------------

.. code-block:: yaml

    # Default configuration for extension with alias: "sonata_admin"
    sonata_admin:
        security:
            handler: sonata.admin.security.handler.noop

            role_admin: ROLE_ADMIN
            role_super_admin: ROLE_SUPER_ADMIN

            information:

                # Prototype
                id: []
            admin_permissions:

                # Defaults:
                - CREATE
                - LIST
                - DELETE
                - UNDELETE
                - EXPORT
                - OPERATOR
                - MASTER
            object_permissions:

                # Defaults:
                - VIEW
                - EDIT
                - HISTORY
                - DELETE
                - UNDELETE
                - OPERATOR
                - MASTER
                - OWNER
            acl_user_manager: null
        title: 'Sonata Admin'
        title_logo: bundles/sonataadmin/images/logo_title.png
        search: true
        default_controller: 'sonata.admin.controller.crud'
        options:
            html5_validate: true

            # Auto order groups and admins by label or id
            sort_admins: false
            confirm_exit: true
            js_debug: false
            skin: 'skin-black'
            use_select2: true
            use_icheck: true
            use_bootlint: false
            use_stickyforms: true
            pager_links: null
            form_type: 'standard' # One of "standard"; "horizontal"
            default_admin_route: show
            default_group: default
            default_translation_domain: SonataAdminBundle
            default_icon: 'fas fa-folder'
            dropdown_number_groups_per_colums:  2
            logo_content: 'all' # One of "text"; "icon"; "all"
            list_action_button_content: 'all' # One of "text"; "icon"; "all"

            # Enable locking when editing an object, if the corresponding object manager supports it.
            lock_protection: false
        dashboard:
            groups:

                # Prototype
                id:
                    label: ~
                    translation_domain: ~
                    icon: ~
                    provider: ~
                    items:
                        admin: ~
                        label: ~
                        route: ~
                        route_params: []
                    roles: []
            blocks:
                type: ~
                roles: []
                settings:

                    # Prototype
                    id: ~
                position: right
                class: col-md-4

        default_admin_services:
            model_manager: null
            data_source: null
            form_contractor: null
            show_builder: null
            list_builder: null
            datagrid_builder: null
            translator: null
            configuration_pool: null
            route_generator: null
            validator: null
            security_handler: null
            label: null
            menu_factory: null
            route_builder: null
            label_translator_strategy: null
            pager_type: null

        templates:
            user_block: '@SonataAdmin/Core/user_block.html.twig'
            add_block: '@SonataAdmin/Core/add_block.html.twig'
            layout: '@SonataAdmin/standard_layout.html.twig'
            ajax: '@SonataAdmin/ajax_layout.html.twig'
            dashboard: '@SonataAdmin/Core/dashboard.html.twig'
            search: '@SonataAdmin/Core/search.html.twig'
            list: '@SonataAdmin/CRUD/list.html.twig'
            filter: '@SonataAdmin/Form/filter_admin_fields.html.twig'
            show: '@SonataAdmin/CRUD/show.html.twig'
            show_compare: '@SonataAdmin/CRUD/show_compare.html.twig'
            edit: '@SonataAdmin/CRUD/edit.html.twig'
            preview: '@SonataAdmin/CRUD/preview.html.twig'
            history: '@SonataAdmin/CRUD/history.html.twig'
            acl: '@SonataAdmin/CRUD/acl.html.twig'
            history_revision_timestamp: '@SonataAdmin/CRUD/history_revision_timestamp.html.twig'
            action: '@SonataAdmin/CRUD/action.html.twig'
            select: '@SonataAdmin/CRUD/list__select.html.twig'
            list_block: '@SonataAdmin/Block/block_admin_list.html.twig'
            search_result_block: '@SonataAdmin/Block/block_search_result.html.twig'
            short_object_description: '@SonataAdmin/Helper/short-object-description.html.twig'
            delete: '@SonataAdmin/CRUD/delete.html.twig'
            batch: '@SonataAdmin/CRUD/list__batch.html.twig'
            batch_confirmation: '@SonataAdmin/CRUD/batch_confirmation.html.twig'
            inner_list_row: '@SonataAdmin/CRUD/list_inner_row.html.twig'
            outer_list_rows_mosaic: '@SonataAdmin/CRUD/list_outer_rows_mosaic.html.twig'
            outer_list_rows_list: '@SonataAdmin/CRUD/list_outer_rows_list.html.twig'
            outer_list_rows_tree: '@SonataAdmin/CRUD/list_outer_rows_tree.html.twig'
            base_list_field: '@SonataAdmin/CRUD/base_list_field.html.twig'
            pager_links: '@SonataAdmin/Pager/links.html.twig'
            pager_results: '@SonataAdmin/Pager/results.html.twig'
            tab_menu_template: '@SonataAdmin/Core/tab_menu_template.html.twig'
            knp_menu_template: '@SonataAdmin/Menu/sonata_menu.html.twig'
            form_theme: []
            filter_theme: []

        assets:
            # all `stylesheets`, `extra_stylesheets`, `remove_stylesheets`,
            # `javascripts`, `extra_javascripts` and `remove_javascripts`
            # can be simple strings or {path, package_name} pairs in case you have to set specific package name for the asset
            stylesheets:

                # The default stylesheet list:
                - bundles/sonataadmin/app.css
                - bundles/sonataform/app.css

            # stylesheets to add to the page in addition to the list above
            extra_stylesheets: []

            # stylesheet paths to remove from the page
            remove_stylesheets: []

            javascripts:

                # The default javascript list:
                - bundles/sonataadmin/app.js
                - bundles/sonataform/app.js

            # javascripts to add to the page in addition to the list above
            extra_javascripts: []

            # javascript paths to remove from the page
            remove_javascripts: []

        extensions:

            # Prototype
            id:
                global: false
                admins: []
                excludes: []
                implements: []
                extends: []
                instanceof: []
                uses: []
                admin_implements: []
                admin_extends: []
                admin_instanceof: []
                admin_uses: []

        persist_filters: false
        filter_persister: sonata.admin.filter_persister.session
        show_mosaic_button: true

        global_search:
            empty_boxes: show
            admin_route: show

        breadcrumbs:
            child_admin_route: show