|squeaky otter e597574e1d||2 years ago|
|config||2 years ago|
|installation||2 years ago|
|lib||2 years ago|
|priv||2 years ago|
|test||2 years ago|
|.credo.exs||4 years ago|
|.formatter.exs||3 years ago|
|.gitignore||2 years ago|
|.gitlab-ci.yml||2 years ago|
|LICENSE||4 years ago|
|README.md||2 years ago|
|TODO.txt||4 years ago|
|mix.exs||2 years ago|
|mix.lock||2 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.
Client applications that are known to work well:
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 @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.
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.
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/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
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.
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 you can put it in
service pleroma start
Logs can be watched by using
journalctl -fu pleroma.service
You can add it to the services ran by default with:
rc-update add pleroma
mix phx.server in repository's root, it will output log into stdout/stderr
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.
Check that you correctly forward the "host" header to backend. It is needed to validate signatures.