Flarum

https://github.com/flarum/framework
Admin
Flarum is a fast, simple, beautiful, and extensible discussion platform designed for building and...
Tokens:4,256
Snippets:75
Trust Score:9.5
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install @flarum/prettier-config

Source: https://github.com/flarum/framework/blob/2.x/js-packages/prettier-config/README.md

Install the configuration package as a development dependency using npm or yarn.

```bash
npm i -D @flarum/prettier-config
yarn add -D @flarum/prettier-config
```

--------------------------------

### Install supervisor

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Installs the supervisor process manager on Debian/Ubuntu or Red Hat/CentOS systems.

```bash
# On Debian / Ubuntu
apt install supervisor

# On Red Hat / CentOS
yum install supervisor
systemctl enable supervisord
```

--------------------------------

### Start websocket server for testing

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Runs the server in debug mode, keeping it active while the terminal remains open.

```bash
php flarum realtime:serve -vvv --debug
```

--------------------------------

### Disable extension toggle auto-restart

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Starts the server while ignoring changes to extension states.

```bash
php flarum realtime:serve --ignore-extension-toggles
```

--------------------------------

### Manage systemd service

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Commands to reload, start, check status, and enable the systemd service.

```bash
sudo systemctl daemon-reload
```

```bash
sudo systemctl start flarum-realtime.service
```

```bash
sudo systemctl status flarum-realtime.service
```

```bash
sudo systemctl enable flarum-realtime.service
```

--------------------------------

### Nginx proxy configuration

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Example nginx server block configuration for proxying the realtime service.

```nginx
server {
  # your php matching instructions
  
  include /var/www/flarum/vendor/blomstra/realtime/.nginx.conf;
	include /var/www/flarum/.nginx.conf;
}
```

--------------------------------

### Install GDPR extension via Composer

Source: https://github.com/flarum/framework/blob/2.x/extensions/gdpr/README.md

Use this command to install the GDPR extension in your Flarum project.

```sh
composer require flarum/gdpr:^2.0.0
```

--------------------------------

### Install Flarum Typescript Config

Source: https://github.com/flarum/framework/blob/2.x/js-packages/tsconfig/README.md

Commands to add the package as a development dependency using npm or yarn.

```properties
npm install --save-dev flarum-tsconfig
yarn add --dev flarum-tsconfig
```

--------------------------------

### Supervisor configuration file

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Configuration for managing the realtime process via supervisor.

```ini
[program:realtime]
command=/usr/bin/php flarum realtime:serve
directory=/var/www/flarum/
numprocs=1
autostart=true
autorestart=true
user=www-data
stdout_logfile=/var/www/flarum/storage/logs/realtime.log
stderr_logfile=/var/www/flarum/storage/logs/realtime-error.log
```

--------------------------------

### Extend Prettier configuration

Source: https://github.com/flarum/framework/blob/2.x/js-packages/prettier-config/README.md

Create a .prettierrc.js file to extend the base configuration with custom options. Ensure the prettier key is removed from package.json when using this method.

```js
// .prettierrc.js
module.exports = {
  ...require("@flarum/prettier-config"),
  semi: false,
};
```

--------------------------------

### Systemd service configuration

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Service file definition for running the realtime server as a systemd daemon.

```ini
[Unit]
Description=flarum-realtime
StartLimitIntervalSec=0

[Service]
Type=simple
User=www-data
WorkingDirectory=/var/www/flarum
ExecStart=/usr/bin/php flarum realtime:serve
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target
```

--------------------------------

### Configure jest.config.cjs

Source: https://github.com/flarum/framework/blob/2.x/js-packages/jest-config/README.md

Create this file to export the Flarum Jest configuration.

```js
module.exports = require('@flarum/jest-config')();
```

--------------------------------

### Configure Prettier in package.json

Source: https://github.com/flarum/framework/blob/2.x/js-packages/prettier-config/README.md

Add the prettier key to your package.json to reference the Flarum configuration.

```jsonc
// package.json
{
  "name": "my-cool-package",
  "version": "1.0.0",
  "prettier": "@flarum/prettier-config",
  // ...
}
```

--------------------------------

### Configure local client host

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Updates Flarum config to use localhost for the websocket client to reduce latency.

```php
return [
    // .. some other instructions
    
    // Make sure the Realtime php client uses localhost instead of the domain
    // to reduce latency.
    'websocket' => [
        'php-client-host' => 'localhost'
    ]
];
```

--------------------------------

### Configure webpack.config.js

Source: https://github.com/flarum/framework/blob/2.x/js-packages/webpack-config/README.md

Basic implementation of the Flarum Webpack configuration in a project's webpack.config.js file.

```js
var config = require('flarum-webpack-config');

module.exports = config(options);
```

--------------------------------

### Manage supervisor service

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Commands to update the configuration and check the status of the supervisor service.

```bash
sudo supervisorctl update
```

```bash
sudo supervisorctl status
```

--------------------------------

### Override Realtime Configuration in config.php

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Add a 'websocket' key to your Flarum config.php file to customize the daemon and client connection settings.

```php
return [
    // ..
    'websocket' => [
    
    ] 
];
```

--------------------------------

### Add Webpack Bundle Analyzer script

Source: https://github.com/flarum/framework/blob/2.x/js-packages/webpack-config/README.md

Add this script to package.json to enable visual bundle analysis during the build process.

```json
{
  "analyze": "npx cross-env ANALYZER=true npm run build"
}
```

--------------------------------

### Resolve PII keys for serialization

Source: https://github.com/flarum/framework/blob/2.x/extensions/gdpr/README.md

Retrieve the aggregated list of PII keys at runtime to redact payloads before sending data to external systems.

```php
use Flarum\Extension\ExtensionManager;
use Flarum\Gdpr\DataProcessor;

$extensions = resolve(ExtensionManager::class);

if ($extensions->isEnabled('flarum-gdpr')) {
    $piiKeys = resolve(DataProcessor::class)->getPiiKeysForSerialization();
} else {
    // Fallback covering common fields — used when flarum/gdpr is not installed.
    $piiKeys = ['email', 'username', 'ip_address', 'last_ip_address'];
}

// Recursively redact PII from your serialized payload before sending externally.
$anonymizedPayload = redactKeys($payload, $piiKeys);
```

--------------------------------

### Manually halt the server

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Forces the realtime server to stop.

```bash
php flarum realtime:halt
```

--------------------------------

### Baseline tsconfig.json Configuration

Source: https://github.com/flarum/framework/blob/2.x/js-packages/tsconfig/README.md

A template for the tsconfig.json file to be placed in the extension's js folder.

```jsonc
{
  // Use Flarum's tsconfig as a starting point
  "extends": "flarum-tsconfig",
  // This will match all .ts, .tsx, .d.ts, .js, .jsx files in your `src` folder
  // and also tells your Typescript server to read core's global typings for
  // access to `dayjs` and `$` in the global namespace.
  "include": ["src/**/*", "../vendor/flarum/core/js/dist-typings/@types/**/*"],
  "compilerOptions": {
    // This will output typings to `dist-typings`
    "declarationDir": "./dist-typings",
    "paths": {
      "flarum/*": ["../vendor/flarum/core/js/dist-typings/*"],
    },
  },
}
```

--------------------------------

### Configure tsconfig.test.json

Source: https://github.com/flarum/framework/blob/2.x/js-packages/jest-config/README.md

Use this configuration file when working with TypeScript to include test files and necessary shims.

```json
{
  "extends": "./tsconfig.json",
  "include": ["tests/**/*"],
  "files": ["../../../node_modules/@flarum/jest-config/shims.d.ts"]
}
```

--------------------------------

### Route GDPR jobs to a specific queue

Source: https://github.com/flarum/framework/blob/2.x/extensions/gdpr/README.md

Configure the queue routing for GDPR jobs in your extend.php file.

```php
use Flarum\Extend;
use Flarum\Gdpr\Jobs\GdprJob;

return [
    // Routes every GDPR job (erasures and exports) — both extend GdprJob.
    (new Extend\Queue())
        ->route(GdprJob::class, 'low'),

    // ... your current extenders,
];
```

--------------------------------

### Register PII keys via UserData extender

Source: https://github.com/flarum/framework/blob/2.x/extensions/gdpr/README.md

Use the UserData extender to register PII keys for fields not associated with a specific data type.

```php
use Flarum\Gdpr\Extend\UserData;

return [
    (new Extend\Conditional())
        ->whenExtensionEnabled('flarum-gdpr', fn () => [
            (new UserData())
                ->addPiiKeysForSerialization(['custom_field', 'another_pii_field']),
        ]),
];
```

--------------------------------

### Register a new Data Type

Source: https://github.com/flarum/framework/blob/2.x/extensions/gdpr/README.md

Add a custom data type to the GDPR export process using the UserData extender within a conditional block.

```php
<?php

use Flarum\Gdpr\Extend\UserData;
use Flarum\Extend;

return [
    (new Extend\Conditional())
        ->whenExtensionEnabled('flarum-gdpr', fn () => [
            (new UserData())
                ->addType(Your\Own\DataType::class),

            ... other conditional extenders as required ...
        ]),
];
```

--------------------------------

### Declare PII fields in a data type class

Source: https://github.com/flarum/framework/blob/2.x/extensions/gdpr/README.md

Override the piiFields method in your data type class to register sensitive keys automatically.

```php
use Flarum\Gdpr\Data\Type;

class MyData extends Type
{
    public static function piiFields(): array
    {
        return ['custom_field', 'another_pii_field'];
    }

    // ... export(), anonymize(), delete() ...
}
```

--------------------------------

### Increase queue worker timeout

Source: https://github.com/flarum/framework/blob/2.x/extensions/realtime/README.md

Run the queue worker with an increased timeout to prevent SendTriggerJob failures.

```bash
php flarum queue:work --timeout=360
```

--------------------------------

### Remove a Data Type

Source: https://github.com/flarum/framework/blob/2.x/extensions/gdpr/README.md

Exclude a specific data type from the GDPR export process.

```php
use Flarum\Gdpr\Extend\UserData;
use Flarum\Extend;

return [
    (new Extend\Conditional())
        ->whenExtensionEnabled('flarum-gdpr', fn () => [
            (new UserData())
                ->removeType(Your\Own\DataType::class),

            ... other conditional extenders as required ...
        ]),
];
```

--------------------------------

### Redact user table columns from exports

Source: https://github.com/flarum/framework/blob/2.x/extensions/gdpr/README.md

Prevent specific sensitive columns from the users table from appearing in the exported data.

```php
use Flarum\Gdpr\Extend\UserData;

return [
    (new Extend\Conditional())
        ->whenExtensionEnabled('flarum-gdpr', fn () => [
            (new UserData())
                ->removeUserColumns(['column1', 'column2']),

            ... other conditional extenders as required ...
        ]),
];
```
Tokens:
Raw