Boring Avatars

IanM

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

bauhaus

Beam

beam

Marble

marble

Pixel

pixel

Ring

ring

Sunset

sunset

Settings

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.

cmsoc

IanM Great extension! Is it possible to add a setting to use this only for user accounts where there is no profile picture?

Yolo

IanM if you have 100's of thousands of users, this could take a few minutes!

i have 1000 users and it takes over 30 minutes and nothing did change.

luceos

Nice one!
Aside from the linked library, it would probably help having some example screenshots.

peopleinside

luceos I agree ^_^

IanM

luceos peopleinside

Give me a chance guys! 😛 Done now..

meetdilip How do I install this Extension using the new Extension manager?

Add using the package name ianm/boring-avatars

meetdilip

Hi, nice one.

How do I install this Extension using the new Extension manager? I installed Flarum with public folder using the tar.gz installer. Thanks.

meetdilip

Hi, thanks, it works 🙂

meetdilip

Hi, is it supposed to look like this?

IanM

meetdilip no. What have you tried so far?

meetdilip

I typed

ianm/boring-avatars

in the box and clicked the " Proceed " button

IanM

meetdilip I'd suggest a good starting point would be to try clearing the cache and/or checking the logs

meetdilip

Hi, I am not sure where the XAMPP logs are, will check.

You are right about the cache. When I tried a different browser, the new avatars are showing. But the settings are still the same as above.

ctml

meetdilip if you have flamoji, try disabling it temporarily.

meetdilip

Hi, under storage > logs I see around 120 times " boring ". Not sure which part of the log is useful to identify the issue

the top area of the log says

[2024-01-19 09:47:26] flarum.ERROR: Illuminate\Contracts\Container\BindingResolutionException: Target [IanM\BoringAvatars\BoringAvatar] is not instantiable while building [IanM\BoringAvatars\Command\GenerateAvatarHandler]. in /opt/lampp/htdocs/flarum_public/vendor/illuminate/container/Container.php:1089
Stack trace:
#0 /opt/lampp/htdocs/flarum_public/vendor/illuminate/container/Container.php(886): Illuminate\Container\Container->notInstantiable('IanM\BoringAvat...')
#1 /opt/lampp/htdocs/flarum_public/vendor/illuminate/container/Container.php(758): Illuminate\Container\Container->build('IanM\BoringAvat...')

meetdilip

ctml Hi, this is a fresh board.

fakruzaruret

@IanM avatars does not shown although I wait 1 hour

imorland/flarum-ext-boring-avatars5

tolgaaaltas

fakruzaruret You may need to purge the cache, I'm using it since day one without any problem.

fakruzaruret

tolgaaaltas I have did it but problem continues.

davetodave178

cmsoc I think this is actually the case by default (but please don't quote me on that 🙂)! You can override this by using the --force argument when generating the Avatars with the CLI. See more in imorland/flarum-ext-boring-avatarsblob/master/src/Console/GenerateBoringAvatars.php

fakruzaruret

I can get avatars with api but it is not shown at interface. I guess it caused by directory of my forum but I am not sure. It is located in main path instead of public folder

site.php

<?php

/*
 * This file is part of Flarum.
 *
 * For detailed copyright and license information, please view the
 * LICENSE file that was distributed with this source code.
 */

/*
|-------------------------------------------------------------------------------
| Load the autoloader
|-------------------------------------------------------------------------------
|
| First, let's include the autoloader, which is generated automatically by
| Composer (PHP's package manager) after installing our dependencies.
| From now on, all classes in our dependencies will be usable without
| explicitly loading any files.
|
*/

require __DIR__.'/vendor/autoload.php';

/*
|-------------------------------------------------------------------------------
| Configure the site
|-------------------------------------------------------------------------------
|
| A Flarum site represents your local installation of Flarum. It can be
| configured with a bunch of paths:
|
| - The *base path* is Flarum's root directory and contains important files
|   such as config.php and extend.php.
| - The *public path* is the directory that serves as document root for the
|   web server. Files in this place are accessible to the public internet.
|   This is where assets such as JavaScript files or CSS stylesheets need to
|   be stored in a default install.
| - The *storage path* is a place for Flarum to store files it generates during
|   runtime. This could be caches, session data or other temporary files.
|
| The fully configured site instance is returned to the including script, which
| then uses it to boot up the Flarum application and e.g. accept web requests.
|
*/

return Flarum\Foundation\Site::fromPaths([
    'base' => __DIR__,
    'public' => __DIR__.'/public',
    'storage' => __DIR__.'/storage',
]);

index.php that is under public folder

<?php

/*
 * This file is part of Flarum.
 *
 * For detailed copyright and license information, please view the
 * LICENSE file that was distributed with this source code.
 */

$site = require '../site.php';

/*
|-------------------------------------------------------------------------------
| Accept incoming HTTP requests
|-------------------------------------------------------------------------------
|
| Every HTTP request pointed to the web server that cannot be served by simply
| responding with one of the files in the "public" directory will be sent to
| this file. Now is the time to boot up Flarum's internal HTTP server, which
| will try its best to interpret the request and return the appropriate
| response, which could be a JSON document (for API responses) or a lot of HTML.
|
*/

$server = new Flarum\Http\Server($site);
$server->listen();

NGINX FILE

server {
    listen      195.XXX.XXX.XXX:443 ssl;
    server_name domain.com www.domain.com;
    root        /home/user/web/domain.com/public_html/public;
    index       index.php index.html index.htm;
    access_log  /var/log/nginx/domains/domain.com.log combined;
    access_log  /var/log/nginx/domains/domain.com.bytes bytes;
    error_log   /var/log/nginx/domains/domain.com.error.log error;

    ssl_certificate      /home/user/conf/web/domain.com/ssl/domain.com.pem;
    ssl_certificate_key  /home/user/conf/web/domain.com/ssl/domain.com.key;
    ssl_stapling on;
    ssl_stapling_verify on;

    include /home/user/conf/web/domain.com/nginx.hsts.conf*;

    location = /favicon.ico {
        log_not_found off;
        access_log off;
    }

    location = /robots.txt {
        allow all;
        log_not_found off;
        access_log off;
    }

    location ~ /\.(?!well-known\/) {
        deny all;
        return 404;
    }

    location / {
        try_files $uri $uri/ /index.php?$args;
        location ~* ^.+\.(ogg|ogv|svg|svgz|swf|eot|otf|woff|woff2|mov|mp3|mp4|webm|flv|ttf|rss|atom|jpg|jpeg|gif|png|webp|ico|bmp|mid|midi|wav|rtf|css|js|jar)$ {
            expires 30d;
            fastcgi_hide_header "Set-Cookie";
        }

        location ~* /(?:uploads|files)/.*.php$ {
            deny all;
            return 404;
        }

        location ~ [^/]\.php(/|$) {
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            try_files $uri =404;
            fastcgi_pass unix:/run/php/php8.2-fpm-domain.com.sock;
            fastcgi_index index.php;
            include /etc/nginx/fastcgi_params;
            include /home/user/conf/web/domain.com/nginx.fastcgi_cache.conf*;
            if ($request_uri ~* "/wp-admin/|/wp-json/|wp-.*.php|xmlrpc.php|index.php|/store.*|/cart.*|/my-account.*|/checkout.*") {
                set $no_cache 1;
            }
            if ($http_cookie ~* "comment_author|wordpress_[a-f0-9]+|wp-postpass|wordpress_no_cache|wordpress_logged_in|woocommerce_items_in_cart|woocommerce_cart_hash|PHPSESSID") {
                set $no_cache 1;
            }
        }
    }

# WORDPRESS #
    location ^~ /vitrin {
    	root        /home/user/web/domain.com/public_html;
        index index.php index.html index.htm;
        try_files $uri $uri/ /vitrin/index.php?$query_string;

        location ~* ^.+\.(ogg|ogv|svg|svgz|swf|eot|otf|woff|woff2|mov|mp3|mp4|webm|flv|ttf|rss|atom|jpg|jpeg|gif|png|webp|ico|bmp|mid|midi|wav|rtf|css|js|jar)$ {
            expires max;
            fastcgi_hide_header "Set-Cookie";
        }

        location ~ [^/]\.php(/|$) {
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            try_files $uri =404;
            fastcgi_pass unix:/run/php/php8.2-fpm-domain.com.sock;
            fastcgi_index index.php;
            include /etc/nginx/fastcgi_params;
            include /home/user/conf/web/domain.com/nginx.fastcgi_cache.conf*;
            if ($request_uri ~* "/wp-admin/|/wp-json/|wp-.*.php|xmlrpc.php|index.php|/store.*|/cart.*|/my-account.*|/checkout.*") {
                set $no_cache 1;
            }
            if ($http_cookie ~* "comment_author|wordpress_[a-f0-9]+|wp-postpass|wordpress_no_cache|wordpress_logged_in|woocommerce_items_in_cart|woocommerce_cart_hash|PHPSESSID") {
                set $no_cache 1;
            }
        }
     }


    location /error/ {
        alias   /home/user/web/domain.com/document_errors/;
    }

    location /vstats/ {
        alias   /home/user/web/domain.com/stats/;
        include /home/user/web/domain.com/stats/auth.conf*;
    }

    proxy_hide_header Upgrade;

    include /etc/nginx/conf.d/phpmyadmin.inc*;
    include /etc/nginx/conf.d/phppgadmin.inc*;
    include /home/user/conf/web/domain.com/nginx.ssl.conf_*;
}