README

Addon for Bear Framework

This addon enables you add CMS functionality to your Bear Framework powered website. Learn more at bearcms.com.

Standalone version

There is a standalone version that is easier to install and update. You can download the installer from your bearcms.com account.

Install via Composer

composer require bearcms/bearframework-addon

Enable the addon

Enable the addon for your Bear Framework application.

$app->addons->add('bearcms/bearframework-addon');
$app->bearCMS->initialize([
    'serverUrl' => 'https://example.bearcms.com/',
    'appSecretKey' => '...',
    'language' => 'en'
]);

Documentation

Full documentation is available as part of this repository.

Components

Creates an elements block.

Creates a block that renders a list of blog posts.

Creates a heading.

Renders HTML code.

Creates an image.

Creates an image gallery.

Creates a link.

Creates a navigation.

Creates a text block.

Creates a video block.

Configuration

Here is a list of the configuration options of the CMS:

serverUrl

The URL of the CMS server. Can be found at your Bear CMS account.

appSecretKey

The site secret key. Can be found at your Bear CMS account.

language

The language of the CMS admin interface. Available values: en, bg.

features

An array containing the enabled CMS features. Available values:

ALL Enables all features.

ADDONS Enables addons.

FILES Enables user files management (uploads, sharing, etc.).

BLOG Enables blog posts.

PAGES Enables managing pages.

ELEMENTS Enables creating elements.

ELEMENTS_HEADING Enables the heading element.

ELEMENTS_TEXT Enables the text element.

ELEMENTS_LINK Enables the link element.

ELEMENTS_IMAGE Enables the image element.

ELEMENTS_IMAGE_GALLERY Enables the image gallery element.

ELEMENTS_VIDEO Enables the video element.

ELEMENTS_NAVIGATION Enables the navigation element.

ELEMENTS_HTML Enables the HTML element.

ELEMENTS_BLOG_POSTS Enables the blog posts element.

ELEMENTS_COLUMNS Enables the columns element.

THEMES Enables themes management.

ABOUT Enables viewing the system information about the website.

SETTINGS Enables managing settings.

USERS Enables users.

USERS_LOGIN_DEFAULT Enables users the login the default way (login form, lost password form, etc.)

USERS_LOGIN_ANONYMOUS Enables anonymous user login (by calling the CMS server with code).

USERS_MANAGE_ACCOUNT Enables the user to manage his account (change password and emails).

adminPagesPathPrefix

The path prefix for the administrators login, lost password and invite pages. The default value is "/admin/".

blogPagesPathPrefix

The path prefix for the blog posts pages. The default value is "/b/".

autoCreateHomePage

Automatically create editable elements container in the home page if no other response is defined. The default value is true.

License

This project is licensed under the MIT License. See the license file for more information.

Author

This addon is created and maintained by the Bear CMS team. Feel free to contact us at support@bearcms.com or bearcms.com.

bearcms / bearframework-addon

Maintainers

Details