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

When first enabled, a background task will be dispatched which will begin generating avatars for all of your users. Needless to say, if you have 100's of thousands of users, this could take a few minutes!

Want to make changes to the generation settings? No problem, once the settings are changed, another background task will run to update the avatars.

This extension is best used alongside a queue, especially when the forum has a large number of users.

An API endpoint is also available to directly retrieve the avatar for a user:

/api/users/[id]/boring-avatar

this will return the SVG image file for the given user.

Installation

Install with composer:

composer require ianm/boring-avatars:"*"

Updating

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

Support

Please consider supporting my extension development and maintenance work.

ianm / boring-avatars

Maintainers

Details