Introduction

Welcome to the ElmapiCMS documentation!

Thank you for purchasing ElmapiCMS. This documentation is designed to help you get started with ElmapiCMS and make the most of its features.

Looking for what changed in recent releases? See the Changelog.

How you bought ElmapiCMS

Start from Installation in the sidebar. If you are not sure whether you have CodeCanyon or GitHub access, open CodeCanyon or GitHub?—it explains the difference and links to the right OS guides.

Shared topics (Configuration, Deployment, and so on) apply no matter how you purchased.

Key Features

ElmapiCMS has been rebuilt from the ground up to provide a more powerful, flexible, and intuitive experience.

Modern Stack & UI

• Rebuilt for Performance: A modern stack featuring Laravel 12, React, TypeScript, and Inertia.js.
• Sleek New UI: A completely redesigned, fully responsive interface built with Shadcn UI.
• Dark Mode: A beautiful dark theme.

Powerful Content Tools

• Flexible Content Modeling: Design custom content structures with 14+ field types, including text, rich text, media, relations, JSON, and more.
• Single Entry Collections: Manage unique, one-off content pages (e.g., "Homepage", "About Us") with a dedicated collection type.
• Advanced Rich Text Editor: The new Lexical editor with source code view, fullscreen editing, and direct media insertion from the Asset Library.
• Duplicate Entries: Clone content entries in a single click.

Advanced Asset Library

• Complete Media Management: A brand new asset library with grid and list views, advanced sorting, and filtering by file type or date.
• Image Editor: Crop images on the fly without leaving the CMS.
• Detailed Metadata: View automatically extracted and comprehensive metadata for all your assets.

Efficient Workflows

• Multi-Project Workspace: Manage all your projects from one central, organized dashboard.
• Project & Collection Templates: Kickstart new projects from pre-built templates, or save your own project and collection structures for reuse.
• Clone Projects: Duplicate an entire project collection structure.
• Built-in Localization: Manage multilingual content.
• Advanced Data Tables: Find content fast with filtering options on all lists.

AI-Powered Content Management

• AI Assistant: A chat-based assistant that can create projects, build collections, manage content entries, and navigate the CMS through natural conversation.
• Inline Content Tools: Generate, rewrite, expand, summarize, fix grammar, and translate text directly in any text, long text, or rich text field.
• AI Entry Translation: Translate entire content entries to another locale with one click, preserving formatting and linking translations automatically.
• MCP Server: Connect Cursor, Claude Code, or any MCP-compatible AI tool directly to your CMS to manage collections, content, and assets through natural language.
• Flexible Providers: Bring your own API key from OpenAI, Anthropic, or Google Gemini.

Robust Security & Integrations

• Granular Access Control: An advanced user, role, and permission system gives you fine-grained control over your team's access.
• High-Performance API: A faster, more capable REST API with advanced filtering capabilities, secured by Laravel Sanctum.
• Webhooks: Notify external services and automate workflows when content changes. All webhook events are logged, and payloads are securely signed.

Server Requirements

ElmapiCMS is built with Laravel 12 and React 19. To run it locally or in production you should have the following software versions (or newer):

• PHP >= 8.4

• Ctype PHP Extension

• cURL PHP Extension

• DOM PHP Extension

• Fileinfo PHP Extension

• Filter PHP Extension

• Hash PHP Extension

• Mbstring PHP Extension

• OpenSSL PHP Extension

• PCRE PHP Extension

• PDO PHP Extension

• Session PHP Extension

• Tokenizer PHP Extension

• XML PHP Extension

• Database:

  • MySQL >= 8.0
  • MariaDB >= 10.5
  • PostgreSQL >= 12.0

• Web Server: Nginx or Apache, configured to serve the public/ directory.

• For Development/Building Assets:

  • Composer >= 2.x
  • Node.js >= 18.x
  • npm >= 9.x (or pnpm/Yarn)

Folder Structure Overview

Here is a general overview of the most important directories within a standard ElmapiCMS installation.

.
├── app/                  # Core Laravel application code
│   ├── Console/          # Artisan commands
│   ├── Events/           # Application events
│   ├── Http/             # Controllers, middleware, and requests
│   │   ├── Controllers/  # Handles incoming HTTP requests
│   │   ├── Middleware/   # Filters HTTP requests
│   │   └── Requests/     # Form request validation
│   ├── Jobs/             # Queueable jobs (e.g., for webhooks)
│   ├── Listeners/        # Event listeners
│   ├── Models/           # Eloquent ORM models
│   └── Providers/        # Service providers
│
├── bootstrap/            # Scripts for bootstrapping the framework
│
├── config/               # Application configuration files
│
├── database/             # Database migrations, factories, and seeders
│
├── public/               # Web server's document root
│
├── resources/            # Front-end source files (React, TS, CSS)
│   ├── js/               # React application source
│   │   ├── components/   # Reusable React components
│   │   ├── hooks/        # Custom React hooks
│   │   ├── lib/          # Utility functions and libraries
│   │   ├── pages/        # Inertia page components
│   │   └── types/        # TypeScript type definitions
│   ├── css/              # TailwindCSS source files
│   └── views/            # The main Blade template for the Inertia app
│
├── routes/               # Route definitions
│
├── storage/              # Compiled templates, session files, logs, and user uploads
│
└── tests/                # Application test suite (Feature & Unit tests)