Plume documentation

Topics

指南

A guide helping you to use Plume

安装 Plume

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

贡献Plume

You want to help, but you don't know how? These guides explain you how to translate Plume, hack on its source code, write documentation, etc.

API文档

借助REST API,Plume可以被其他应用程序扩展。

Plume是如何实现Federate的

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.

Organization

Documents that are mostly useful for internal organization

Updating your instance

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

常用的环境变量

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

plm命令行程序参考

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.