Plume documentation

Topics

Installing Plume

A guide to install your own Plume instance, using various methods (Docker, YunoHost, from source, etc)

Development Guide

How to install Plume on your computer and make changes to the source code. This guide also gives you tips for making debugging and testing easier.

API documentation

Plume can be extended by other applications thanks to a REST API.

How Plume Federates

A summary of the standards Plume uses to federate, how they are implemented, and which parts of these standards are available or not in Plume.

Updating your instance

Plume is still unstable and regularly gets new features and bug fixes. Keeping your instance up-to-date is important.

Useful Environment Variables

Plume uses environment variable to configure instances. You can use them to configure the database, or the HTTP interface for instance.

plm CLI reference

plm is a little CLI tool that can help you to manage your instance from the command line if you are admin of an instance.