### Flarum Getting Started
Source: https://docs.flarum.org/it/2.x/extend/frontend
A guide for new developers to get started with Flarum extension development, covering the initial setup and basic concepts.
```markdown
## Iniziare
A guide for new developers to get started with Flarum extension development, covering the initial setup and basic concepts.
```
--------------------------------
### Flarum Extension Getting Started
Source: https://docs.flarum.org/vi/2.x/extend/frontend-pages
A guide for new developers to get started with Flarum extension development.
```vi
Bắt đầu
https://docs.flarum.org/vi/2.x/extend/start
```
--------------------------------
### Flarum Extension Development: Getting Started
Source: https://docs.flarum.org/vi/2.x/extend/search
A guide for new developers to begin creating Flarum extensions, covering the initial setup and basic principles.
```vi
Bắt đầu
https://docs.flarum.org/vi/2.x/extend/start
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/es/2.x/extend/search
A beginner's guide to starting Flarum extension development. This section covers the initial setup, project structure, and basic concepts needed to create your first extension.
```es
https://docs.flarum.org/es/2.x/extend/start
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/2.x/extend/extensibility
A guide to getting started with developing extensions for Flarum, covering the initial setup and basic concepts.
```PHP
Getting Started:
- Setting up your development environment.
- Creating your first extension.
- Reference: https://docs.flarum.org/2.x/extend/start
```
--------------------------------
### Flarum Extension Development - Start Guide
Source: https://docs.flarum.org/vi/2.x/extend/filesystem
A beginner's guide to starting Flarum extension development, covering initial setup and basic concepts.
```markdown
## Getting Started
This guide will walk you through the initial steps of developing your first Flarum extension.
* **Prerequisites**: Software and tools required for development.
* **Extension Structure**: Understanding the basic file and directory structure of an extension.
* **Creating an Extension**: Steps to generate a new extension skeleton.
* **Basic Functionality**: Adding simple features like custom routes or settings.
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/de/2.x/extend/authorization
A guide for new developers to get started with Flarum extension development, covering prerequisites and initial setup.
```APIDOC
Getting Started:
- Prerequisites for extension development (PHP, Composer).
- Setting up a local Flarum development environment.
- Creating your first extension skeleton.
```
--------------------------------
### Flarum Extension Development Start Guide
Source: https://docs.flarum.org/zh/2.x/extend/extensibility
A beginner's guide to starting Flarum extension development, covering initial setup and basic concepts.
```zh
开始
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/es/2.x/extend/formatting
A guide for new developers to get started with Flarum extension development.
```es
https://docs.flarum.org/es/2.x/extend/start
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/it/2.x/extend/language-packs
A guide to getting started with Flarum extension development.
```it
Iniziare
https://docs.flarum.org/it/2.x/extend/start
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/es/2.x/extend/admin
A guide for new developers on how to get started with Flarum extension development.
```APIDOC
Cómo empezar:
Descripción: Una guía para que los nuevos desarrolladores comiencen con el desarrollo de extensiones de Flarum.
Enlace: https://docs.flarum.org/es/2.x/extend/start
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/es/extend/api-throttling
A guide for new developers on how to start building Flarum extensions. Covers the basic structure and setup required.
```APIDOC
Getting Started with Flarum Extensions:
Overview: This guide walks you through the initial steps of creating your first Flarum extension.
Prerequisites:
- Basic understanding of PHP and JavaScript.
- Composer installed.
- Flarum instance installed.
Steps:
1. Create a new extension directory in the `extensions` folder of your Flarum installation.
2. Create a `composer.json` file for your extension's metadata.
3. Create an `extension.php` file to register your extension's services and components.
4. Use Flarum's CLI tools for scaffolding and managing your extension.
Example `composer.json`:
```json
{
"name": "vendor/my-extension",
"description": "My first Flarum extension.",
"type": "flarum-extension",
"require": {
"flarum": "^1.0"
},
"autoload": {
"psr-4": {
"Vendor\\MyExtension\\": "src/"
}
},
"extra": {
"flarum-extension": {
"title": "My Extension"
}
}
}
```
```
--------------------------------
### Flarum Theming Quick Start
Source: https://docs.flarum.org/es/2.x/extend/testing
A quick guide to getting started with theming Flarum extensions.
```markdown
Inicio rápido:
URL: https://docs.flarum.org/es/2.x/extend/theme
Basic steps to customize the appearance of your Flarum extensions.
```
--------------------------------
### Flarum Test Case Setup Example
Source: https://docs.flarum.org/de/extend/testing
An example demonstrating the setup of a Flarum integration test case. It shows how to use methods like `setting()`, `extension()`, `prepareDatabase()`, and `extend()` to configure the test environment, including overriding settings, enabling extensions, populating the database, and applying extenders.
```php
setting('my.custom.setting',true);
// Let's assume our extension depends on tags.
// Note that tags will need to be in your extension's composer.json's `require-dev`.
// Also, make sure you include the ID of the extension currently being tested, unless you're
// testing the baseline without your extension.
$this->extension('flarum-tags','my-cool-extension');
// Note that this input isn't validated: make sure you're populating with valid, representative data.
$this->prepareDatabase([
'users'=>[
$this->normalUser()// Available for convenience.
],
'discussions'=>[
['id'=>1,'title'=>'some title','created_at'=>Carbon::now(),'last_posted_at'=>Carbon::now(),'user_id'=>1,'first_post_id'=>1,'comment_count'=>1]
],
'posts'=>[
['id'=>1,'number'=>1,'discussion_id'=>1,'created_at'=>Carbon::now(),'user_id'=>1,'type'=>'comment','content'=>'something
']
]
]);
// Most test cases won't need to test extenders, but if you want to, you can.
$this->extend((newCoolExtensionExtender)->doSomething('hello world'));
}
/**
* @test
*/
publicfunctionsome_phpunit_test_case()
{
// ...
}
// ...
}
```
--------------------------------
### Install Flarum Extension with Composer
Source: https://docs.flarum.org/extend/start
This command installs your Flarum extension using Composer. Ensure you are in the root directory of your Flarum installation. The `@dev` tag is used for development versions.
```bash
composer require acme/flarum-hello-world *@dev
```
--------------------------------
### Flarum Extension Development - How to Start
Source: https://docs.flarum.org/es/2.x/extend/forms
A beginner's guide to starting Flarum extension development, covering setup and basic concepts.
```APIDOC
API Documentation for Getting Started:
This guide provides a step-by-step introduction to developing Flarum extensions. It covers the initial setup, project structure, and fundamental concepts required to begin.
Key steps:
- Setting up a development environment
- Creating a basic extension structure
- Understanding the extension lifecycle
- Registering the extension
This is the ideal starting point for new extension developers.
```
--------------------------------
### Flarum Extension Development - Theme Quick Start
Source: https://docs.flarum.org/es/2.x/extend/admin
A quick start guide for theming Flarum extensions, covering basic customization and setup.
```APIDOC
Inicio rápido:
Descripción: Una guía de inicio rápido para la tematización de extensiones de Flarum, que cubre la personalización y configuración básicas.
Enlace: https://docs.flarum.org/es/2.x/extend/theme
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/es/extend/language-packs
This guide provides the initial steps and fundamental concepts for developers looking to start building Flarum extensions.
```es
Cómo empezar
https://docs.flarum.org/es/extend/start
```
--------------------------------
### Hello World Extension Example
Source: https://docs.flarum.org/extend/start
A basic 'Hello World' extension for Flarum. This example registers a JavaScript alert to be displayed on the forum frontend by modifying the document's head.
```PHP
content(function(Document$document){
$document->head[]='';
})
];
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/es/2.x/extend/testing
Provides a starting point for developers new to extending Flarum, covering essential setup and concepts.
```markdown
Cómo empezar:
URL: https://docs.flarum.org/es/2.x/extend/start
This guide walks you through the initial steps of creating your first Flarum extension.
```
--------------------------------
### Install Flarum Extension with Composer
Source: https://docs.flarum.org/2.x/extend/start
This command installs a Flarum extension using Composer. It requires the extension's package name and can specify a development version. After installation, the extension needs to be enabled through the Flarum administration panel.
```bash
composer require acme/flarum-hello-world *@dev
```
--------------------------------
### Flarum Test Case Setup Example
Source: https://docs.flarum.org/zh/extend/testing
An example demonstrating how to use Flarum's testing utilities within a PHPUnit test case. It shows overriding settings, enabling extensions, preparing the database with users and discussions, and using extenders.
```php
setting('my.custom.setting',true);
// Let's assume our extension depends on tags.
// Note that tags will need to be in your extension's composer.json's `require-dev`.
// Also, make sure you include the ID of the extension currently being tested, unless you're
// testing the baseline without your extension.
$this->extension('flarum-tags','my-cool-extension');
// Note that this input isn't validated: make sure you're populating with valid, representative data.
$this->prepareDatabase([
'users'=>[
$this->normalUser()// Available for convenience.
],
'discussions'=>[
['id'=>1,'title'=>'some title','created_at'=>Carbon::now(),'last_posted_at'=>Carbon::now(),'user_id'=>1,'first_post_id'=>1,'comment_count'=>1]
],
'posts'=>[
['id'=>1,'number'=>1,'discussion_id'=>1,'created_at'=>Carbon::now(),'user_id'=>1,'type'=>'comment','content'=>'something
']
]
]);
// Most test cases won't need to test extenders, but if you want to, you can.
// Assuming CoolExtensionExtender and doSomething are defined elsewhere.
// $this->extend((newCoolExtensionExtender)->doSomething('hello world'));
}
/**
* @test
*/
publicfunctionsome_phpunit_test_case()
{
// Test logic here...
$this->assertTrue(true);
}
// ... other test methods
}
```
--------------------------------
### Flarum Extension Development Guides
Source: https://docs.flarum.org/it/2.x/extend/filesystem
This section outlines the various guides available for developing Flarum extensions. It covers main concepts, getting started, frontend development, routing, models, API usage, distribution, and developer workflows.
```markdown
- [README](https://docs.flarum.org/it/2.x/extend/)
- [Iniziare](https://docs.flarum.org/it/2.x/extend/start)
- [Sviluppo del Frontend](https://docs.flarum.org/it/2.x/extend/frontend)
- [Percorsi e contenuti](https://docs.flarum.org/it/2.x/extend/routes)
- [Modelli e migrazioni](https://docs.flarum.org/it/2.x/extend/models)
- [API e flusso di dati](https://docs.flarum.org/it/2.x/extend/api)
- [Distribuzione](https://docs.flarum.org/it/2.x/extend/distribution)
- [Sviluppatori che spiegano il loro flusso di lavoro per lo sviluppo di estensioni](https://docs.flarum.org/it/2.x/extend/cli)
```
--------------------------------
### Flarum Test Case Setup Example
Source: https://docs.flarum.org/zh/2.x/extend/testing
An example demonstrating how to use Flarum's testing utilities within a PHPUnit test case. It shows overriding settings, enabling extensions, preparing the database with users and discussions, and applying extenders.
```php
setting('my.custom.setting',true);
// Let's assume our extension depends on tags.
// Note that tags will need to be in your extension's composer.json's `require-dev`.
// Also, make sure you include the ID of the extension currently being tested, unless you're
// testing the baseline without your extension.
$this->extension('flarum-tags','my-cool-extension');
// Note that this input isn't validated: make sure you're populating with valid, representative data.
$this->prepareDatabase([
'users'=>[
$this->normalUser()// Available for convenience.
],
'discussions'=>[
['id'=>1,'title'=>'some title','created_at'=>Carbon::now(),'last_posted_at'=>Carbon::now(),'user_id'=>1,'first_post_id'=>1,'comment_count'=>1]
],
'posts'=>[
['id'=>1,'number'=>1,'discussion_id'=>1,'created_at'=>Carbon::now(),'user_id'=>1,'type'=>'comment','content'=>'something
']
]
]);
// Most test cases won't need to test extenders, but if you want to, you can.
$this->extend((newCoolExtensionExtender)->doSomething('hello world'));
}
/**
* @test
*/
publicfunctionsome_phpunit_test_case()
{
// ...
}
// ...
}
```
--------------------------------
### Installare estensione Flarum con Composer
Source: https://docs.flarum.org/it/extend/start
Comando per installare un'estensione Flarum locale o di sviluppo utilizzando Composer. Assicurati di essere nella directory principale della tua installazione Flarum.
```bash
composer require acme/flarum-hello-world *@dev
```
--------------------------------
### Flarum Extension Reference Guides
Source: https://docs.flarum.org/it/extend/start
This section details various reference guides for Flarum extension development, including the admin panel, backend events, authorization, frontend pages, interactive components, internationalization, language packs, forms, permissions, settings, static code analysis, testing, theming, views, and GitHub Actions.
```markdown
- Reference Guides
* [Pannello amministrazione](https://docs.flarum.org/it/extend/admin)
* [Eventi backend](https://docs.flarum.org/it/extend/backend-events)
* [Autorizzazione](https://docs.flarum.org/it/extend/authorization)
* [Frontend e Resolver](https://docs.flarum.org/it/extend/frontend-pages)
* [Componenti interattivi](https://docs.flarum.org/it/extend/interactive-components)
* [Internazionalizzazione](https://docs.flarum.org/it/extend/i18n)
* [Tradurre Flarum](https://docs.flarum.org/it/extend/language-packs)
* [Moduli e richieste](https://docs.flarum.org/it/extend/forms)
* [Gruppi e autorizzazioni](https://docs.flarum.org/it/extend/permissions)
* [Impostazioni](https://docs.flarum.org/it/extend/settings)
* [Static Code Analysis](https://docs.flarum.org/it/extend/static-code-analysis)
* [Test](https://docs.flarum.org/it/extend/testing)
* [Guida rapida](https://docs.flarum.org/it/extend/theme)
* [Views and Blade](https://docs.flarum.org/it/extend/views)
* [GitHub Actions (Workflows)](https://docs.flarum.org/it/extend/github-actions)
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/es/2.x/extend/start
This section covers the initial steps and core concepts for developing Flarum extensions. It includes an overview of the extension structure and basic setup.
```markdown
## Main Concepts
* [README](https://docs.flarum.org/es/2.x/extend/)
* [Cómo empezar](https://docs.flarum.org/es/2.x/extend/start)
* [Desarrollo del Frontend](https://docs.flarum.org/es/2.x/extend/frontend)
* [Rutas y contenido](https://docs.flarum.org/es/2.x/extend/routes)
* [Models and Migrations](https://docs.flarum.org/es/2.x/extend/models)
* [API and Data Flow](https://docs.flarum.org/es/2.x/extend/api)
* [Distribución](https://docs.flarum.org/es/2.x/extend/distribution)
* [Desarrolladores explicando su flujo de trabajo para el desarrollo de extensiones](https://docs.flarum.org/es/2.x/extend/cli)
```
--------------------------------
### Khởi tạo Tiện ích mở rộng Flarum bằng Flarum CLI
Source: https://docs.flarum.org/vi/extend/start
Sử dụng lệnh `flarum-cli init` để tự động tạo cấu trúc cơ bản và các tệp cần thiết cho một tiện ích mở rộng Flarum mới.
```bash
$ flarum-cli init
```
--------------------------------
### Caddy Configuration for Flarum
Source: https://docs.flarum.org/it/2.x/install
Basic Caddy configuration for Flarum. Replace example URLs and paths with your specific setup. Adjust the `php_fastcgi` path if using a different PHP version or socket.
```caddy
www.example.com {
root * /var/www/flarum/public
php_fastcgi unix//var/run/php/php7.4-fpm.sock
header /assets/* {
+Cache-Control "public, must-revalidate, proxy-revalidate"
+Cache-Control "max-age=25000"
Pragma "public"
}
file_server
}
```
--------------------------------
### Registrare file frontend con Extender
Source: https://docs.flarum.org/it/extend/start
Questo snippet mostra come utilizzare la classe `ExtendFrontend` per registrare file JavaScript e CSS specifici per il frontend del forum. L'approccio basato su extender garantisce la compatibilità con le future versioni di Flarum.
```php
use Flarum\Extend;
(new Extend\Frontend('forum'))
->js(__DIR__.'/forum-scripts.js')
->css(__DIR__.'/forum-styles.css')
```
--------------------------------
### Flarum Installation Guide
Source: https://docs.flarum.org/2.x/code-of-conduct
A step-by-step guide to installing Flarum, covering prerequisites, database setup, and initial configuration.
```APIDOC
Installation:
- Comprehensive guide to setting up a new Flarum instance.
- Covers server requirements, database configuration, and Composer installation.
- Initial setup steps and verification.
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/vi/2.x/extend/start
This section covers the fundamental concepts and initial steps for developing extensions in Flarum. It includes an overview of the extension structure and basic setup.
```markdown
## Khái niệm chính
* [README](https://docs.flarum.org/vi/2.x/extend/)
* [Bắt đầu](https://docs.flarum.org/vi/2.x/extend/start)
* [Phát triển Frontend](https://docs.flarum.org/vi/2.x/extend/frontend)
* [Routes và Nội dung](https://docs.flarum.org/vi/2.x/extend/routes)
* [Models và Migrations](https://docs.flarum.org/vi/2.x/extend/models)
* [API và Luồng dữ liệu](https://docs.flarum.org/vi/2.x/extend/api)
* [Phân bổ](https://docs.flarum.org/vi/2.x/extend/distribution)
* [Flarum CLI](https://docs.flarum.org/vi/2.x/extend/cli)
```
--------------------------------
### Caddy Web Server Configuration
Source: https://docs.flarum.org/zh/install
Example Caddy configuration for serving a Flarum installation. Remember to replace example URLs and paths with your actual configuration.
```caddy
www.example.com {
root * /var/www/flarum/public
php_fastcgi unix//var/run/php/php7.4-fpm.sock
header /assets/* {
+Cache-Control "public, must-revalidate, proxy-revalidate"
+Cache-Control "max-age=25000"
Pragma "public"
}
file_server
}
```
--------------------------------
### Flarum Theme Quick Start
Source: https://docs.flarum.org/es/extend/routes
A quick guide to getting started with theming Flarum extensions.
```APIDOC
Theme Quick Start:
- Basic steps to start customizing the appearance of Flarum extensions.
- Covers overriding templates and styling components.
- Aims to provide a simple entry point for theming.
```
--------------------------------
### Flarum Extension Advanced Guides
Source: https://docs.flarum.org/it/extend/start
This section covers advanced topics in Flarum extension development, including API throttling, extension assets, console commands, extending extensions, extensibility, filesystem, formatting, mail, middleware, model visibility, slugging, notifications, post types, search, and service providers.
```markdown
- Advanced Guides
* [Limitazione delle API](https://docs.flarum.org/it/extend/api-throttling)
* [Risorse Estensione](https://docs.flarum.org/it/extend/assets)
* [Console](https://docs.flarum.org/it/extend/console)
* [Estendere le Estensioni](https://docs.flarum.org/it/extend/extending-extensions)
* [Estensibilità](https://docs.flarum.org/it/extend/extensibility)
* [Filesystem](https://docs.flarum.org/it/extend/filesystem)
* [Formattazione](https://docs.flarum.org/it/extend/formatting)
* [Mail](https://docs.flarum.org/it/extend/mail)
* [Middleware](https://docs.flarum.org/it/extend/middleware)
* [Visibilità Modelli](https://docs.flarum.org/it/extend/model-visibility)
* [Modello Slugging](https://docs.flarum.org/it/extend/slugging)
* [Notifiche](https://docs.flarum.org/it/extend/notifications)
* [Tipi di post](https://docs.flarum.org/it/extend/post-types)
* [Cerca](https://docs.flarum.org/it/extend/search)
* [Provider di servizi](https://docs.flarum.org/it/extend/service-provider)
```
--------------------------------
### Flarum Extension Development - Getting Started
Source: https://docs.flarum.org/it/2.x/extend/notifications
A guide for new developers on how to start building Flarum extensions.
```markdown
## Iniziare
Questa guida è pensata per i nuovi sviluppatori che desiderano iniziare a creare estensioni per Flarum. Copre i prerequisiti, la struttura di base di un'estensione e i primi passi nel processo di sviluppo.
```
--------------------------------
### Install Flarum Extension via Composer
Source: https://docs.flarum.org/es/extend/start
Installs a Flarum extension into your Flarum installation using Composer. The '@dev' flag is often used for local development.
```bash
composer require acme/flarum-hello-world *@dev
```
--------------------------------
### Hello World Extension
Source: https://docs.flarum.org/vi/extend/start
Ví dụ này hiển thị cách tạo một extension Flarum đơn giản để hiển thị một cảnh báo 'Hello, world!' trên frontend. Nó sử dụng extender để thêm mã JavaScript tùy chỉnh vào phần tử head của tài liệu.
```PHP
content(function(Document$document) {
$document->head[]='';
})
];
```
--------------------------------
### Flarum PHP API Documentation
Source: https://docs.flarum.org/es/extend/start
Documentación de la API de PHP para el namespace Flarum\Extend. Proporciona acceso a las clases y métodos utilizados para extender la funcionalidad de Flarum, incluyendo la configuración del frontend y otras extensiones.
```APIDOC
Namespace: Flarum\Extend
Classes:
Frontend
__construct(string $context)
Initializes the Frontend extender for a given context (e.g., 'forum').
js(string $path): static
Registers a JavaScript file to be included in the frontend.
Parameters:
- path: The path to the JavaScript file.
Returns: The extender instance for chaining.
css(string $path): static
Registers a CSS file to be included in the frontend.
Parameters:
- path: The path to the CSS file.
Returns: The extender instance for chaining.
// Other extenders available in the Flarum core can be found here:
// https://github.com/flarum/framework/blob/main/framework/core/src/Extend
// Extensions may also offer their own extenders.
```
--------------------------------
### Flarum Theme Quick Start Guide
Source: https://docs.flarum.org/es/2.x/extend/static-code-analysis
A quick start guide for theming Flarum extensions.
```markdown
Theme Quick Start:
https://docs.flarum.org/es/2.x/extend/theme
```
--------------------------------
### Setup Flarum Testing Environment
Source: https://docs.flarum.org/zh/2.x/extend/testing
Run the `composer test:setup` command in your extension's root directory to prepare the testing environment. This command configures the necessary components for running integration tests.
```bash
composer test:setup
```
--------------------------------
### Flarum Test Case Setup Utilities
Source: https://docs.flarum.org/it/2.x/extend/testing
Demonstrates the usage of various utilities for setting up Flarum integration tests. This includes overriding settings and configurations, enabling extensions, preparing the database with custom data, and applying extenders. It also shows how to use the `normalUser()` helper and the importance of calling setup methods before the application boots.
```php
setting('my.custom.setting', true);
// Let's assume our extension depends on tags.
// Note that tags will need to be in your extension's composer.json's `require-dev`.
// Also, make sure you include the ID of the extension currently being tested, unless you're
// testing the baseline without your extension.
$this->extension('flarum-tags', 'my-cool-extension');
// Note that this input isn't validated: make sure you're populating with valid, representative data.
$this->prepareDatabase([
'users' => [
$this->normalUser() // Available for convenience.
],
'discussions' => [
['id' => 1, 'title' => 'some title', 'created_at' => Carbon::now(), 'last_posted_at' => Carbon::now(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1]
],
'posts' => [
['id' => 1, 'number' => 1, 'discussion_id' => 1, 'created_at' => Carbon::now(), 'user_id' => 1, 'type' => 'comment', 'content' => 'something
']
]
]);
// Most test cases won't need to test extenders, but if you want to, you can.
// $this->extend((new CoolExtensionExtender)->doSomething('hello world'));
}
/**
* @test
*/
public function some_phpunit_test_case()
{
// ...
}
// ...
}
```
--------------------------------
### Flarum config.php Example
Source: https://docs.flarum.org/zh/2.x/config
An example of the `config.php` file used in Flarum installations. This file contains critical information for Flarum to function, including database connection details and operational modes.
```php
false, // Enable or disable debug mode for troubleshooting
'offline' => false, // Enable or disable website maintenance mode
'database' => [
'driver' => 'mysql', // Database driver (e.g., MySQL, MariaDB)
'host' => 'localhost', // Database host
'database' => 'flarum', // Database instance name
'username' => 'root', // Database username
'password' => '', // Database password
'charset' => 'utf8mb4',
'collation' => 'utf8mb4_unicode_ci',
'prefix' => '', // Table prefix for shared databases
'port' => '3306', // Database connection port
'strict' => false,
],
'url' => 'https://flarum.localhost', // Flarum installation URL
'paths' => [
'api' => 'api', // API endpoint path
'admin' => 'admin', // Admin area path
],
];
```
--------------------------------
### Run Testing Setup
Source: https://docs.flarum.org/zh/extend/testing
Executes the setup script to prepare the testing environment after configuring the necessary environment variables.
```bash
composer test:setup
```
--------------------------------
### Caddy Web Server Configuration
Source: https://docs.flarum.org/zh/2.x/install
Example Caddy configuration for serving a Flarum installation. This includes setting the document root, PHP FastCGI endpoint, and cache headers for static assets.
```caddy
www.example.com {
root * /var/www/flarum/public
php_fastcgi unix//var/run/php/php7.4-fpm.sock
header /assets/* {
+Cache-Control "public, must-revalidate, proxy-revalidate"
+Cache-Control "max-age=25000"
Pragma "public"
}
file_server
}
```
--------------------------------
### Initialize Flarum Extension with Flarum CLI
Source: https://docs.flarum.org/es/extend/start
Uses the Flarum CLI tool to generate the basic scaffolding for a new Flarum extension.
```bash
$ flarum-cli init
```
--------------------------------
### PHP API Documentation - Extend Namespace
Source: https://docs.flarum.org/it/extend/start
Documentazione API per il namespace `Extend` di Flarum, che contiene le classi utilizzate per creare e configurare estensioni. Include riferimenti a classi come `Frontend`.
```APIDOC
Extend Namespace:
Descrizione: Fornisce le classi base per la creazione di estensioni Flarum.
Classi principali:
Frontend:
Descrizione: Utilizzato per estendere il frontend del forum.
Metodi:
js(string $path): Registra un file JavaScript.
css(string $path): Registra un file CSS.
content(callable $callback): Aggiunge contenuto alla pagina frontend.
(Altre classi extender sono disponibili nel namespace)
```
--------------------------------
### Flarum Extension Update Guides
Source: https://docs.flarum.org/it/extend/start
This section provides guides for updating Flarum extensions across different versions, including updates for 1.x, 1.0, Beta 16, Beta 15, Beta 14, Beta 13, Beta 12, Beta 10, and Beta 8.
```markdown
- Update Guides
* [Updating For 1.x](https://docs.flarum.org/it/extend/update-1_x)
* [Updating For 1.0](https://docs.flarum.org/it/extend/update-1_0)
* [Aggiornamenti per Beta 16](https://docs.flarum.org/it/extend/update-b16)
* [Aggiornamenti Beta 15](https://docs.flarum.org/it/extend/update-b15)
* [Updating For Beta 14](https://docs.flarum.org/it/extend/update-b14)
* [Updating For Beta 13](https://docs.flarum.org/it/extend/update-b13)
* [Updating For Beta 12](https://docs.flarum.org/it/extend/update-b12)
* [Updating For Beta 10](https://docs.flarum.org/it/extend/update-b10)
* [Updating For Beta 8](https://docs.flarum.org/it/extend/update-b8)
```
--------------------------------
### Flarum Extension Development Guides
Source: https://docs.flarum.org/de/2.x/extend/theme
Overview of Flarum extension development, including core concepts and getting started.
```APIDOC
Hauptkonzepte:
README: https://docs.flarum.org/de/2.x/extend/
Getting Started: https://docs.flarum.org/de/2.x/extend/start
Frontend Development: https://docs.flarum.org/de/2.x/extend/frontend
Routes and Content: https://docs.flarum.org/de/2.x/extend/routes
Models and Migrations: https://docs.flarum.org/de/2.x/extend/models
API and Data Flow: https://docs.flarum.org/de/2.x/extend/api
Distribution: https://docs.flarum.org/de/2.x/extend/distribution
Flarum CLI: https://docs.flarum.org/de/2.x/extend/cli
```
--------------------------------
### Flarum Extension Development Guides
Source: https://docs.flarum.org/es/extend/extensibility
This section outlines the core concepts and guides for developing Flarum extensions. It covers essential topics such as getting started, frontend development, routing, models, API interaction, and distribution.
```markdown
- [README](https://docs.flarum.org/es/extend/)
- [Cómo empezar](https://docs.flarum.org/es/extend/start)
- [Desarrollo del Frontend](https://docs.flarum.org/es/extend/frontend)
- [Rutas y contenido](https://docs.flarum.org/es/extend/routes)
- [Models and Migrations](https://docs.flarum.org/es/extend/models)
- [API and Data Flow](https://docs.flarum.org/es/extend/api)
- [Distribución](https://docs.flarum.org/es/extend/distribution)
- [Desarrolladores explicando su flujo de trabajo para el desarrollo de extensiones](https://docs.flarum.org/es/extend/cli)
```
--------------------------------
### Flarum Extension Development Overview
Source: https://docs.flarum.org/2.x/extend/start
This section outlines the key areas and concepts involved in developing extensions for Flarum. It covers the entire lifecycle from initial setup to advanced features.
```markdown
# Getting Started
Want to build a Flarum extension? You've come to the right place! This document will take you through some essential concepts, after which you'll build your first Flarum extension from scratch.
## Main Concepts
* Extending Flarum
* Getting Started
* Frontend Development
* Routes and Content
* Models and Migrations
* API and Data Flow
* Distribution
* Flarum CLI
## Update Guides
* Updating For 2.0
* Upgrading to 2.0 API Layer
## Reference Guides
* Admin Dashboard
* Backend Events
* Authorization
* Frontend Pages and Resolvers
* Interactive Components
* Internationalization
* Translating Flarum
* Forms and Requests
* Groups and Permissions
* Settings
* Static Code Analysis
* Testing
* Themes
* Views and Blade
* GitHub Actions (Workflows)
## Advanced Guides
* API Throttling
* Extension Assets
* Console
* Database
* Extending Extensions
* Extensibility
* Filesystem
* Formatting
* Mail Drivers
* Middleware
* Model Visibility
* Model Slugging
* Notifications
* Post Types
* Searching and Filtering
* Service Provider
* Export Registry
* Code Splitting
```
--------------------------------
### Flarum Extension Development Topics
Source: https://docs.flarum.org/es/extend/distribution
This section outlines the core concepts and reference guides for developing Flarum extensions. It covers topics from getting started to advanced features like API acceleration and middleware.
```markdown
- Main Concepts
* [README](https://docs.flarum.org/es/extend/)
* [Cómo empezar](https://docs.flarum.org/es/extend/start)
* [Desarrollo del Frontend](https://docs.flarum.org/es/extend/frontend)
* [Rutas y contenido](https://docs.flarum.org/es/extend/routes)
* [Models and Migrations](https://docs.flarum.org/es/extend/models)
* [API and Data Flow](https://docs.flarum.org/es/extend/api)
* [Distribución](https://docs.flarum.org/es/extend/distribution)
* [Desarrolladores explicando su flujo de trabajo para el desarrollo de extensiones](https://docs.flarum.org/es/extend/cli)
- Reference Guides
* [Panel de Administración](https://docs.flarum.org/es/extend/admin)
* [Eventos del Backend](https://docs.flarum.org/es/extend/backend-events)
* [Autorización](https://docs.flarum.org/es/extend/authorization)
* [Páginas del frontend y Resolvers](https://docs.flarum.org/es/extend/frontend-pages)
* [Componentes Interactivos](https://docs.flarum.org/es/extend/interactive-components)
* [Internacionalización](https://docs.flarum.org/es/extend/i18n)
* [Traducción de Flarum](https://docs.flarum.org/es/extend/language-packs)
* [Formularios y peticiones](https://docs.flarum.org/es/extend/forms)
* [Grupos y permisos](https://docs.flarum.org/es/extend/permissions)
* [Ajustes](https://docs.flarum.org/es/extend/settings)
* [Static Code Analysis](https://docs.flarum.org/es/extend/static-code-analysis)
* [Testing](https://docs.flarum.org/es/extend/testing)
* [Inicio rápido](https://docs.flarum.org/es/extend/theme)
* [Views and Blade](https://docs.flarum.org/es/extend/views)
* [GitHub Actions (Workflows)](https://docs.flarum.org/es/extend/github-actions)
- Advanced Guides
* [Aceleración de la API](https://docs.flarum.org/es/extend/api-throttling)
* [Extension Assets](https://docs.flarum.org/es/extend/assets)
* [Consola](https://docs.flarum.org/es/extend/console)
* [Extending Extensions](https://docs.flarum.org/es/extend/extending-extensions)
* [Extensibility](https://docs.flarum.org/es/extend/extensibility)
* [Filesystem](https://docs.flarum.org/es/extend/filesystem)
* [Formatting](https://docs.flarum.org/es/extend/formatting)
* [Correo](https://docs.flarum.org/es/extend/mail)
* [Middleware](https://docs.flarum.org/es/extend/middleware)
* [Model Visibility](https://docs.flarum.org/es/extend/model-visibility)
* [Model Slugging](https://docs.flarum.org/es/extend/slugging)
* [Notificaciones](https://docs.flarum.org/es/extend/notifications)
* [Post Types](https://docs.flarum.org/es/extend/post-types)
* [Search](https://docs.flarum.org/es/extend/search)
* [Proveedor de servicios](https://docs.flarum.org/es/extend/service-provider)
```
--------------------------------
### Running Flarum Test Setup
Source: https://docs.flarum.org/de/extend/testing
Executes the command to set up the Flarum testing environment after configuring the necessary environment variables. This command prepares the database and temporary directories for integration tests.
```bash
composer test:setup
```
--------------------------------
### Flarum Extension Development Guides
Source: https://docs.flarum.org/es/2.x/extend/views
This section outlines the core concepts and guides for developing Flarum extensions. It covers essential topics for getting started, managing frontend and backend aspects, and distributing your extensions.
```markdown
- [README](https://docs.flarum.org/es/2.x/extend/)
- [Cómo empezar](https://docs.flarum.org/es/2.x/extend/start)
- [Desarrollo del Frontend](https://docs.flarum.org/es/2.x/extend/frontend)
- [Rutas y contenido](https://docs.flarum.org/es/2.x/extend/routes)
- [Models and Migrations](https://docs.flarum.org/es/2.x/extend/models)
- [API and Data Flow](https://docs.flarum.org/es/2.x/extend/api)
- [Distribución](https://docs.flarum.org/es/2.x/extend/distribution)
- [Desarrolladores explicando su flujo de trabajo para el desarrollo de extensiones](https://docs.flarum.org/es/2.x/extend/cli)
```