Piefed Onboarding Plugin

This plugin allows an admin to do a series of actions for a new user after their account is verified.

Features

One thing to note generally about all these features, is that any entities referenced here must already be known to your instance. As an example, this plugin will not be able to auto-subscribe new users to a community that has not federated to your instance already or create a block for a domain that isn't known to your instance. The same logic holds true for all entities here: instances, domains, communities, users, feeds.

Default Blocklists

You can specify lists of instances, domains, communities, and users to add to a new user's blocklist. The provided config.py has example values already populated, feel free to customize these to your heart's content. These blocks are removable by the user in their settings page at a later time if they should choose to do so.

Default Subscriptions

You can specify communities and feeds that you want new users to be subscribed to when their account is created. Again, the provided config.py has examples that you can customize. Users are free to leave these communities and feeds at any time afterwards.

Welcome Message

You can provide a markdown-formatted message that will be sent as a private message to the user when their account is verified. In the message, you can use the $user_name placeholder to substitute in the user name of the new user receiving the message. You must specify the user_id of the user that you want to be the one sending the message. The code will enforce that the sender is a user that is local to the instance.

Installation

To use this plugin:

1. Clone this repository into the app/plugins folder of your piefed instance.
2. Edit the config.py file to your desired state. See the file comments for explanations of options.
3. Restart/rebuild your piefed instance to register the plugin.

The new plugin should be automatically detected by piefed and will be triggered whenever a new user is verified.

Requirements

Currently, the plugin requires a recent enough build to include the new_user hook. That means at least the 1.3.0-dev builds as I write this and it should roll out to a stable branch on piefed versions >=1.3.0.