kaniini 69d557e86d Merge branch 'twitter-api-direct-messages' into 'develop' 9 hours ago
config http security: allow referrer-policy to be configured 2 days ago
installation Merge branch 'add-MIX_ENV-to-systemd-example' into 'develop' 1 day ago
lib Merge branch 'twitter-api-direct-messages' into 'develop' 9 hours ago
priv Move /litepub-1.0.jsonld to /schemas/litepub-0.1.jsonld 5 days ago
test TwitterApi: Add direct message endpoint 23 hours ago
.credo.exs Refactor code to comply with credo suggestions 1 year ago
.formatter.exs add formatter 6 months ago
.gitignore Fix follow errors 5 months ago
.gitlab-ci.yml use more modern elixir 1 week ago
LICENSE Add license 1 year ago
README.md Add Whalebird as a client application in README 2 days ago
TODO.txt Output proper published data in ostatus. 1 year ago
mix.exs config/config.md: Create 4 days ago
mix.lock Add ex_doc 4 days ago



About Pleroma

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.

For clients it supports both the GNU Social API with Qvitter extensions and the Mastodon client API.

Client applications that are known to work well:

  • Twidere
  • Tusky
  • Pawoo (Android + iOS)
  • Subway Tooter
  • Amaroq (iOS)
  • Tootdon (Android + iOS)
  • Tootle (iOS)
  • Whalebird (Windows + Mac + Linux)

No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org.



While we don't provide docker files, other people have written very good ones. Take a look at https://github.com/Angristan/dockerfiles/tree/master/pleroma or https://github.com/sn0w/pleroma-docker.


  • Postgresql version 9.6 or newer
  • Elixir version 1.5 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


  • Run mix deps.get to install elixir dependencies.

  • Run mix generate_config. This will ask you a few questions about your instance and generate a configuration file in config/generated_config.exs. Check that and copy it to either config/dev.secret.exs or config/prod.secret.exs. It will also create a config/setup_db.psql; you may want to double-check this file in case you wanted a different username, or database name than the default. Then you need to run the script as PostgreSQL superuser (i.e. sudo su postgres -c "psql -f config/setup_db.psql"). It will create a pleroma db user, database and will setup needed extensions that need to be set up. Postgresql super-user 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 config/config.md

  • Run mix ecto.migrate to 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.server and 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 you can put it in /etc/systemd/system/. Running service pleroma start Logs can be watched by using journalctl -fu pleroma.service

As OpenRC service (with provided RC file)

Copy installation/init.d/pleroma to /etc/init.d/pleroma. You can add it to the services ran by default with: rc-update add pleroma

Standalone/run by other means

Run 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 dev.secret.exs or prod.secret.exs if you want to proxify all http requests that pleroma makes to an upstream proxy server:

config :pleroma, :http,
  proxy_url: ""

This is useful for running pleroma inside Tor or i2p.


No incoming federation

Check that you correctly forward the "host" header to backend. It is needed to validate signatures.