README

A Flarum extension. Replace default Flarum avatars with Boring Avatars.

About

Utilize generated "Boring Avatars" on your Flarum forum, without compromising your user privacy. It is a PHP port of the React based Boring Avatars

Features

• Choose from 6 themes + plus an exclusive animated version of the "ring" theme
• Customize the color palette used
• Completely self contained, no external calls are required
• Multiple identifier configuration (Select from ID, username or email address to generate unique avatars)
• SVG avatars, which are directly included in the user object - no additional network requests to retrieve avatars
• Automatically updates the avatar if the identifier changes
• Supports GDPR export, anonymization, deletion

Screenshots

Bauhaus

Beam

Marble

Pixel

Ring

Sunset

Settings

Usage

After enabling, select Boring Avatars as the avatar driver under Admin → Basics → Avatar Driver. Avatars are generated on first view and cached automatically, so no background jobs or queue setup is required.

Changing any setting (theme, colors, identifier) will clear all cached avatars, and they will be regenerated as users are next viewed.

To eagerly pre-generate avatars for all users, run:

php flarum boringavatars:generate

Use --force to regenerate avatars for users who already have one.

Installation

Install with composer:

composer require ianm/boring-avatars:"*"

Updating

composer update ianm/boring-avatars:"*"
php flarum migrate
php flarum cache:clear

Links

• Packagist
• GitHub
• Discuss
• Extension Icon

Support

Please consider supporting my extension development and maintenance work.