blackcube/admin

Blackcube CMS Administration system

3.5.1 2024-10-30 21:13 UTC

Requires

• php: >=8.0
• ext-dom: *
• ext-fileinfo: *
• ext-intl: *
• ext-json: *
• blackcube/core: 3.5.1
• hashids/hashids: ~4.1
• swaggest/json-schema: ~0.12
• vlucas/phpdotenv: ~5.4
• web-auth/webauthn-lib: ^5.0
• wolfcast/browser-detection: ^2.9
• yiisoft/yii2: ~2.0.13
• yiisoft/yii2-imagine: ~2.3

Requires (Dev)

• codeception/codeception: ~5.0
• codeception/module-asserts: ~2.0
• codeception/module-yii2: ~1.1
• yiisoft/yii2-debug: ~2.1
• yiisoft/yii2-gii: ~2.2

proprietary

• Philippe Gaultier

• admin
• cms
• content management
• yii
• yii2
• back office
• blackcube

README

Pre-requisites

• PHP 7.4+
  • Extension dom
  • Extension fileinfo
  • Extension intl
  • Extension json
  • Extension mbstring
• Apache or NginX
• Blackcube core 3;x

Pre-flight

Add blackcube admin to the project

composer require "blackcube/admin" 

Installation

Beware: Blackcube admin can only be installed if Blackcube core is already set up

Inject Blackcube admin in application

// main configuration file
   'container' => [
      'singletons' => [
         // local filesystem
         blackcube\core\components\Flysystem::class => [
            'class' => blackcube\core\components\FlysystemLocal::class,
            'path' => getstrenv('FILESYSTEM_LOCAL_PATH'),
         ],
         // or s3
         blackcube\core\components\Flysystem::class => [
            'class' => blackcube\core\components\FlysystemAwsS3::class,
            'key' => getstrenv('FILESYSTEM_S3_KEY'),
            'secret' => getstrenv('FILESYSTEM_S3_SECRET'),
            'bucket' => getstrenv('FILESYSTEM_S3_BUCKET'),
            'region' => getstrenv('FILESYSTEM_S3_REGION'),
            'version' => 'latest',
            'endpoint' => getstrenv('FILESYSTEM_S3_ENDPOINT'),
            'pathStyleEndpoint' => getboolenv('FILESYSTEM_S3_PATH_STYLE'),
         ],
      ]
   ],
   // ...
   'bootstrap' => [
      // ... boostrapped modules
      'blackcube', // blackcube core
      'bo', // blackcube admin
   ],
   // ...
   'modules' => [
      // ... other modules
      'blackcube' => [
         'class' => blackcube\core\Module::class,
         'plugins' => [
            // additional plugins
         ],
         'cmsEnabledmodules' => [
            // additional modules
         ],
         'allowedParameterDomains' => ['],
            // override components if needed
            'components' => [
               'db' => ...
               'cache' => ...
               'fs' => ...
            ],
            /// end override
      ],
      'bo' => [
         'class' => blackcube\admin\Module::class,
         'adminTemplatesAlias' => '@app/admin',
         'additionalAssets' => [
            // additional modules
         ],
         'modules' => [
            // additional modules
         ],
            // override components if needed
            'components' => [
               'db' => ...
               'cache' => ...
               'fs' => ...
            ],
            /// end override
      ],
   ],
// ...

Update DB

Add needed tables in DB

php yii.php migrate

Init all RBAC Roles and permissions

php yii.php bc:rbac

the command must be run each time a new Rbac (role / permssion) is added through a module or plugin

Create initial administrator

php yii.php bc:admin/create 

Blackcube admin is now ready, you can access it through https://host.domain/bo