Note: This readme as well as complete documentation is also available at https://docs-develop.pleroma.social
Pleroma is a microblogging server software that can federate (= exchange messages with) other servers that support the same federation standards (OStatus and ActivityPub). What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger servers. Pleroma will federate with all servers that implement either OStatus or ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.
Pleroma is written in Elixir, high-performance and can run on small devices like a Raspberry Pi.
If you want to run your own server, feel free to contact us at @email@example.com or in our dev chat at #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org.
Note: The guide below may be outdated and in most cases shouldn't be used. Instead check out our wiki for platform-specific installation instructions, most likely Installing on Linux using OTP releases is the guide you need.
Currently Pleroma is not packaged by any OS/Distros, but feel free to reach out to us at #pleroma-dev on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma-dev:matrix.org for assistance. If you want to change default options in your Pleroma package, please discuss it with us first.
- Postgresql version 9.6 or newer
- Elixir version 1.7 or newer. If your distribution only has an old version available, check Elixir’s install page or use a tool like asdf.
- Build-essential tools
mix deps.getto install elixir dependencies.
mix pleroma.instance gen. This will ask you questions about your instance and generate a configuration file in
config/generated_config.exs. Check that and copy it to either
config/prod.secret.exs. It will also create a
config/setup_db.psql, which you should run as the PostgreSQL superuser (i.e.,
sudo -u postgres psql -f config/setup_db.psql). It will create the database, user, and password you gave
mix pleroma.gen.instanceearlier, as well as set up the necessary extensions in the database. PostgreSQL superuser privileges are only needed for this step.
- For these next steps, the default will be to run pleroma using the dev configuration file,
config/dev.secret.exs. To run them using the prod config file, prefix each command at the shell with
MIX_ENV=prod. For example:
MIX_ENV=prod mix phx.server. Documentation for the config can be found at
docs/config.mdin the repository, or at the "Configuration" page on https://docs-develop.pleroma.social/config.html
mix ecto.migrateto run the database migrations. You will have to do this again after certain updates.
- You can check if your instance is configured correctly by running it with
mix phx.serverand checking the instance info endpoint at
/api/v1/instance. If it shows your uri, name and email correctly, you are configured correctly. If it shows something like
localhost:4000, your configuration is probably wrong, unless you are running a local development setup.
- The common and convenient way for adding HTTPS is by using Nginx as a reverse proxy. You can look at example Nginx configuration in
installation/pleroma.nginx. If you need TLS/SSL certificates for HTTPS, you can look get some for free with letsencrypt: https://letsencrypt.org/. The simplest way to obtain and install a certificate is to use Certbot. Depending on your specific setup, certbot may be able to get a certificate and configure your web server automatically.
- By default, it listens on port 4000 (TCP), so you can access it on http://localhost:4000/ (if you are on the same machine). In case of an error it will restart automatically.
Pleroma comes with two frontends. The first one, Pleroma FE, can be reached by normally visiting the site. The other one, based on the Mastodon project, can be found by visiting the /web path of your site.
As systemd service (with provided .service file)
Example .service file can be found in
installation/pleroma.service. Copy this to
systemctl enable --now pleroma.service will run Pleroma and enable startup on boot. Logs can be watched by using
journalctl -fu pleroma.service.
As OpenRC service (with provided RC file)
/etc/init.d/pleroma. You can add it to the services ran by default with:
rc-update add pleroma
Standalone/run by other means
mix phx.server in repository’s root, it will output log into stdout/stderr.
Using an upstream proxy for federation
Add the following to your
prod.secret.exs if you want to proxify all http requests that Pleroma makes to an upstream proxy server:
config :pleroma, :http, proxy_url: "127.0.0.1:8123"
This is useful for running Pleroma inside Tor or I2P.
Customization and contribution
The Pleroma Documentation offers manuals and guides on how to further customize your instance to your liking and how you can contribute to the project.
No incoming federation
Check that you correctly forward the
host header to the backend. It is needed to validate signatures.