flarum/framework
Framework
This project is a self-hosted forum software and extensible community platform designed to facilitate online discussions and member engagement. It functions as a REST API discussion engine, providing a backend that manages community interactions and forum data via a standardized JSON interface for external applications.
The platform is distinguished by a modular architecture that allows for deep customization through a package-based extension system and an interface extension framework. It employs an extender-based customization model, enabling external modules to modify internal system behavior by registering callbacks.
The framework covers a broad range of administrative and operational capabilities, including permission-based access control, multilingual support management, and automated background task scheduling. It also provides tools for database migration management, administrative action logging, and the configuration of email delivery drivers.
The system includes a command-line utility for retrieving system versioning and extension status for debugging purposes.
Features
- Forum Software Frameworks - Provides a modular framework for extending forum functionality through custom extensions and API integrations.
- Forums & Communities - Functions as a web-based application for community management and threaded long-form discussions.
- External API Integrations - Enables connecting forum content to external applications using a REST API for retrieval and updates.
- Self-Hosted Discussion Boards - Provides a private, self-hosted installation for managing community conversations and discussion threads.
- Database Migrations - Provides tools for versioning and applying schema changes to ensure database compatibility across software versions.
- REST APIs - Provides a comprehensive REST API for programmatic retrieval and modification of forum data and community interactions.
- Extension Package Managers - Features a dedicated system for managing third-party add-ons through dependency resolution and repository-based installation.
- REST API Interfaces - Exposes forum functionality and data through a standardized REST-based JSON interface for external clients.
- API Request Authentication - Secures endpoints using session cookies, API keys, or short-lived access tokens for external scripts.
- Permission-Based Access Control - Regulates user capabilities across the platform by mapping specific access scopes to roles and groups.
- User Access Management - Defines global and specific access scopes for user groups to control member capabilities across the platform.
- Extensibility Frameworks - Provides a comprehensive framework for creating extensions that modify the software's structure and behavior.
- Extensible Plugin Architectures - Employs a modular architecture that allows deep customization through a package-based extension system.
- Plugin Extenders - Uses an extender-based architecture allowing external modules to modify internal system behavior via registered callbacks.
- Community Moderation Systems - Provides administrative tools and workflows for filtering content and managing user interactions to maintain community order.
- User Account Administration - Provides tools to list all members, edit profiles, and perform administrative actions on user accounts.
- REST API Backends - Acts as a server-side REST API backend that exposes endpoints for managing forum data and interactions.
- Community Profile Configurations - Allows administrators to configure the community name, description, welcome banner, and global email settings.
- Multilingual Content Management - Manages translation keys and locale files to provide localized content and interfaces for international audiences.
- Background Task Schedulers - Automates repetitive system maintenance through a scheduled background task execution system.
- Task Schedulers - Executes registered background jobs at regular intervals for maintenance and automated community postings.
- Programmatic Thread Creation - Exposes an API endpoint for the programmatic submission of new discussion threads to the community.
- Database Schema Migrations - Uses versioned migration scripts to automate database schema updates and ensure structural compatibility.
- Background Task Schedulers - Implements a task runner to execute repetitive maintenance and automated background jobs at fixed intervals.
- Multilingual Site Support - Provides tools for installing language packs, toggling translated interfaces, and setting default global languages.
- Audit Log Filters - Allows searching and isolating specific events within system activity logs by actor, action, or IP address.
- Moderation Action Logs - Records moderation events to a read-only log to track administrative actions.
- Appearance Customizations - Provides administrative tools for modifying visual themes, color schemes, branding, and logos.
- Style Injections - Provides mechanisms for overriding default system styles by applying custom CSS rules to the theme engine.
- Interface Localization - Includes tools for translating user interface labels and extension text into multiple languages.
- Extension Administration Interfaces - Provides a graphical administrative interface to install, update, enable, and configure third-party add-ons.
- Php Projects - Listed in the “Php Projects” section of the Awesome For Beginners awesome list.
