flarum/core
Core
This project is a self-hosted community engine and forum software designed for hosting threaded discussions. It functions as a JSON API community platform, exposing all data and functionality through a standardized interface to support a single-page application architecture. The system is built to be a multi-language discussion board with integrated localization and language pack support.
The platform is defined by a modular architecture that allows for extensive customization through an extension-based plugin system. This extensibility enables the modification of core behavior, the addition of new features, and the application of custom visual themes. It further allows for specific behavioral tweaks to application logic without requiring the build of a full extension.
The software covers a broad range of administrative and operational capabilities, including member administration, user permission control, and community data migration from legacy systems. It includes tools for system monitoring via audit logs and statistics, automated task scheduling for background jobs, and a flexible email delivery configuration. Visual identity is managed through custom HTML injection, CSS styling, and branding asset management.
The system uses a command-line interface for dependency management and retrieving system diagnostics.
Features
- JSON API Frameworks - Functions as a JSON API community platform, exposing all data and functionality through a standardized interface.
- Forums & Communities - Provides a complete web-based platform for hosting threaded community discussions.
- Multi-Language Community Platforms - Functions as a multi-language discussion board with integrated localization and language pack support.
- Self-Hosted Discussion Boards - Provides self-hosted forum software for managing threaded community discussions with a modern UI.
- Database Migration Management - Implements a system for executing versioned database schema changes to maintain data integrity.
- REST APIs - Exposes a standardized REST API for retrieving community data and managing forum functionality.
- Email Delivery Configurations - Provides configuration for outgoing mail servers and delivery services for system notifications.
- Community Forums - Exposes all community data and functionality through a standardized JSON interface to support a single-page application.
- Member Administration - Includes tools for managing user accounts, assigning permissions, and moderating member activity.
- Permission-Based Access Control - Implements a security model where access to functionality is granted based on specific permissions assigned to user groups.
- CSRF Protections - Implements validation tokens to protect state-changing API endpoints against cross-site request forgery.
- Database Schema Migrations - Manages evolving data structures using versioned migration files to ensure database consistency.
- Plugin Architectures - Employs a modular architecture and extension-based plugin system for high customization.
- Single Page Applications - Utilizes a single-page application architecture to render the UI dynamically via API calls.
- Hook-Based Plugin Systems - Employs a hook-based plugin system allowing third-party modules to modify core behavior.
- System Setting Configurations - Provides an interface for managing system-wide configurations, including outgoing mail server settings.
- User Account Management - Provides administrative interfaces for managing user profiles and performing moderation actions.
- REST API Backends - Functions as a REST API backend that serves as the single source of truth for the frontend.
- Legacy Data Import - Facilitates moving users, posts, and threads from legacy forum software into the system.
- Background Task Schedulers - Executes registered background jobs such as database cleanups and sitemap generation.
- Community Extension Installers - Enables the installation and configuration of third-party community extensions through a graphical interface.
- Extension Managers - Provides tools to install, update, and remove core software and extensions via CLI or GUI.
- Task Schedulers - Provides a mechanism to run background tasks at defined intervals for automated maintenance.
- API Discussion Creation - Provides a dedicated API interface for the programmatic submission of new discussion threads.
- Data Migration Tools - Ships tools to migrate community data, including users and discussions, from legacy forum software.
- API Request Authentication - Verifies request identity using session cookies for browsers and access tokens for external scripts.
- Token Authentication - Supports stateless token authentication using API keys for secure non-browser client communication.
- Audit Log Tracking - Records moderation and administration events to a read-only, tamper-resistant log.
- Background Job Queues - Implements a background job queue for executing deferred maintenance and system cleanups.
- Community Activity Metrics - Displays high-level metrics and data regarding community growth and activity.
- Appearance Customizations - Provides an administrative interface to manage theme colors, dark mode, and branding assets like logos.
- Site Appearance Customizations - Allows modification of visual identity and behavioral logic through custom styles and an extension system.
- Multi-Language Content Delivery - Supports the installation of language packs and allows users to switch the display language via the UI.
- Content Translation - Translates interface text and extension strings into multiple languages using external management tools.
- CSS Preprocessors - Implements a styling pipeline that compiles LESS or CSS assets into static files for theming.
- Content and Communication - Next-generation forum software for online discussions.
- Media and Communication - Simple forum software for community building.
