Ekaterina Vaartis a1aacc08a4 | 5 years ago | |
---|---|---|
config | 5 years ago | |
docs | 5 years ago | |
installation | 5 years ago | |
lib | 5 years ago | |
priv | 5 years ago | |
test | 5 years ago | |
.credo.exs | 5 years ago | |
.formatter.exs | 6 years ago | |
.gitignore | 5 years ago | |
.gitlab-ci.yml | 5 years ago | |
LICENSE | 7 years ago | |
README.md | 5 years ago | |
mix.exs | 5 years ago | |
mix.lock | 5 years ago |
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.
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/docker-pleroma or https://github.com/sn0w/pleroma-docker.
mix deps.get
to 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/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.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
mix ecto.migrate
to run the database migrations. You will have to do this again after certain updates.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.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.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.
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
.
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
Run mix phx.server
in repository’s root, it will output log into stdout/stderr.
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.
The Pleroma Wiki offers manuals and guides on how to further customize your instance to your liking and how you can contribute to the project.
Check that you correctly forward the host
header to the backend. It is needed to validate signatures.