README

The easy, flexible and scalable API-first PagibleAI CMS package:

• AI generates/enhances drafts and images for you
• Manage structured content like in Contentful
• Define new content elements in seconds
• Assign shared content to multiple pages
• Save, publish and revert drafts
• Extremly fast JSON frontend API
• Versatile GraphQL admin API
• Multi-language support
• Multi-domain routing
• Multi-tenancy capable
• Supports soft-deletes
• Fully Open Source
• Scales from single page with SQLite to millions of pages with DB clusters

It can be installed into any existing Laravel application.

Table of contents

• Installation
• Authorization
• Configuration
• Clean up
• Multi-domain
• Multi-tenancy
• MCP API
• Security

Installation

You need a working Laravel installation. If you don't have one, you can create it using:

composer create-project laravel/laravel pagible
cd pagible

The application will be available in the ./pagible sub-directory. Then, run this command within your Laravel application directory:

composer req aimeos/pagible
php artisan cms:install
php artisan migrate

Now, adapt the .env file of your application and change the APP_URL setting to your domain. If you are using php artisan serve for testing, add the port of the internal web server (APP_URL=http://localhost:8000). Otherwise, the uploading files will fail because they wouldn't be loaded!

Add a line in the "post-update-cmd" section of your composer.json file to update the admin backend files after each update:

"post-update-cmd": [
    "@php artisan vendor:publish --force --tag=admin",
    "@php artisan vendor:publish --tag=public",
    "@php artisan migrate",
    ...
],

Authorization

To allow existing users to edit CMS content or to create a new users if they don't exist yet, you can use the cms:user command (replace the e-mail address by the users one):

php artisan cms:user editor@example.com

To disallow users to edit CMS content, use:

php artisan cms:user --disable editor@example.com

The CMS admin backend is available at (replace "mydomain.tld" with your own one):

http://mydomain.tld/cmsadmin

Configuration

Captcha protection

To protect forms like the contact form against misuse and spam, you can add the HCaptcha service. Sign up at their web site and create an account.

In the HCaptcha dashboard, go to the Sites page and add an entry for your web site. When you click on the newly generated entry, the sitekey is shown on top. Add this to your .env file as:

HCAPTCHA_SITEKEY="..."

In the account settings, you will find the secret that is required too in your .env file as:

HCAPTCHA_SECRET="..."

AI support

To generate texts/images from prompts, analyze image/video/audio content, or execute actions based on your prompts, you have to configure one or more of the AI service providers supported by the Prism and Prisma packages.

Note: You only need to configure API keys for the AI service providers you are using, not for all!

All service providers require to sign-up and create an account first. They will provide an API key which you need to add to your .env file or as environment variable, e.g.:

GEMINI_API_KEY="..."
OPENAI_API_KEY="..."
CLIPDROP_API_KEY="..."
DEEPL_API_KEY="..."

# Text translation
CMS_AI_TRANSLATE_API_KEY="${DEEPL_API_KEY}"
# For DeepL Pro accounts
# CMS_AI_TRANSLATE_URL="https://api.deepl.com/"

# Analyze content and generate text/images
CMS_AI_WRITE_API_KEY="${GEMINI_API_KEY}"
CMS_AI_REFINE_API_KEY="${GEMINI_API_KEY}"
CMS_AI_DESCRIBE_API_KEY="${GEMINI_API_KEY}"
CMS_AI_IMAGINE_API_KEY="${GEMINI_API_KEY}"
CMS_AI_INPAINT_API_KEY="${GEMINI_API_KEY}"
CMS_AI_REPAINT_API_KEY="${GEMINI_API_KEY}"

# Image manipulation
CMS_AI_ERASE_API_KEY="${CLIPDROP_API_KEY}"
CMS_AI_ISOLATE_API_KEY="${CLIPDROP_API_KEY}"
CMS_AI_UNCROP_API_KEY="${CLIPDROP_API_KEY}"
CMS_AI_UPSCALE_API_KEY="${CLIPDROP_API_KEY}"

# Audio transcription
CMS_AI_TRANSCRIBE_API_KEY="${OPENAI_API_KEY}"

For best results and all features, you need Google, OpenAI, Clipdrop, and DeepL at the moment and they are also configured by default. If you want to use a different provider or model, you can to configure them in your .env file too. Please have a look into the ./config/cms.php for the used environment variables.

Note: You can also configure the base URLs for each provider using the url key in each provider configuration, e.g.:

    'transcribe' => [ // Transcribe audio
        'provider' => env( 'CMS_AI_TRANSCRIBE', 'openai' ),
        'model' => env( 'CMS_AI_TRANSCRIBE_MODEL', 'whisper-1' ),
        'api_key' => env( 'CMS_AI_TRANSCRIBE_API_KEY' ),
        'url' => 'https://openai-api.compatible-provider.com'
    ],

Publishing

For scheduled publishing, you need to add this line to the routes/console.php class:

\Illuminate\Support\Facades\Schedule::command('cms:publish')->daily();

Clean up

To clean up soft-deleted pages, elements and files regularly, add these lines to the routes/console.php class:

\Illuminate\Support\Facades\Schedule::command('model:prune', [
    '--model' => [
        \Aimeos\Cms\Models\Page::class,
        \Aimeos\Cms\Models\Element::class,
        \Aimeos\Cms\Models\File::class
    ],
])->daily();

You can configure the timeframe after soft-deleted items will be removed permantently by setting the CMS_PURGE option in your .env file. It's value must be the number of days after the items will be removed permanently or FALSE if the soft-deleted items shouldn't be removed at all.

Multi-domain

Using multiple page trees with different domains is possible by adding CMS_MULTIDOMAIN=true to your .env file.

Multi-tenancy

PagibleAI CMS supports single database multi-tenancy using existing Laravel tenancy packages or code implemented by your own.

The Tenancy for Laravel package is most often used. How to set up the package is described in the tenancy quickstart and take a look into the single database tenancy article too.

Afterwards, tell PagibleAI CMS how the ID of the current tenant can be retrieved. Add this code to the boot() method of your \App\Providers\AppServiceProvider in the ./app/Providers/AppServiceProvider.php file:

\Aimeos\Cms\Tenancy::$callback = function() {
    return tenancy()->initialized ? tenant()->getTenantKey() : '';
};

MCP API

PagibleAI CMS offers tools within the Laravel MCP API that LLMs can use to interact with the CMS. To make them available, you have to add this line to your ./routes/ai.php route file:

Mcp::oauthRoutes();
Mcp::web('/mcp/cms', \Aimeos\Cms\Mcp\CmsServer::class)->middleware('auth:api');

Note: You need to set up Laravel Passport for MCP OAuth authentication too!

Security

If you find a security related issue, please contact security at aimeos.org.

Special thanks to:

• Lwin Min Oo