No Description https://pleroma.social/

Haelwenn 3d76420512 Merge branch 'feature/pleroma-ctl-rpc' into 'develop' 17 hours ago
config c2ca1f22a2 it is changed in compile time 4 days ago
docs 6745bc951c Documentation: Document chat token response. 3 days ago
installation abedcca349 Sample Mongoose IM config. 2 weeks ago
lib 49a49d3763 Merge branch 'removing-test-errors' into 'develop' 1 day ago
priv c2ca1f22a2 it is changed in compile time 4 days ago
rel 448d739b25 pleroma_ctl: Run mix tasks using rpc instead of eval 21 hours ago
test 49a49d3763 Merge branch 'removing-test-errors' into 'develop' 1 day ago
uploads 31852f906e fix issues with the uploads directory 1 month ago
.buildpacks 4e45f7bc87 CI: Add auto-deployment via dokku. 2 weeks ago
.credo.exs 4b73ca638e [Credo][CI] Add readability as it’s fixed 3 months ago
.formatter.exs ce7618f6f6 add formatter 1 year ago
.gitignore c869ec2504 Prevent committing code coverage results to the repo 1 month ago
.gitlab-ci.yml 8fbe1a3b92 remove the feature branch from only 4 days ago
AGPL-3 362603c723 LICENSE → AGPL-3 2 months ago
CC-BY-NC-ND-4.0 0bab2661ae COPYING: Add copyright notice for the finmojis 2 months ago
CC-BY-SA-4.0 32e843f033 CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license 2 months ago
CHANGELOG.md 0632ed2f87 Apply suggestion to CHANGELOG.md 3 days ago
COPYING 566a968ab3 pleroma-fox-tan-shy.png: Add another version of pleroma-tan 1 month ago
Procfile 4e45f7bc87 CI: Add auto-deployment via dokku. 2 weeks ago
README.md 03dc19e7b0 Update release info in README.md 1 month ago
elixir_buildpack.config 4e45f7bc87 CI: Add auto-deployment via dokku. 2 weeks ago
mix.exs 57d54a9f09 Merge branch 'fix/991-version-generation' into 'develop' 2 days ago
mix.lock 2ad5a8511d Update Phoenix to 1.4.8 3 days ago

README.md

Pleroma

Note: This readme as well as complete documentation is also available at https://docs-develop.pleroma.social

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.

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.

Installation

Docker

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

Dependencies

  • 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

Configuration

  • Run mix deps.get to install elixir dependencies.
  • Run 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/dev.secret.exs or 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.instance earlier, 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.md in the repository, or at the "Configuration" page on https://docs-develop.pleroma.social/config.html
  • 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.

Running

  • 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.

Frontends

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 /etc/systemd/system/. Running 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)

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: "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.

Troubleshooting

No incoming federation

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