Working copy for sending patches. May be force-pushed any time.
Find a file
Morgan Bazalgette 676f2ca479
Bring mastofe up to date
Commit 5edce20302

summary:

```
*   5edce203 - (4 minutes ago) Merge branch 'master' of github.com:tootsuite/mastodon - Morgan Bazalgette (HEAD -> master, origin/master, origin/HEAD)
|\
| * 2c51bc0c - (4 hours ago)  Add missing rejection handling for Promises (#7008) - unarist (upstream/master)
| * e7a17167 - (5 hours ago) Implement the ability for an Administrator or Moderator to remove an account avatar (#6998) - Emelia Smith
| * 4fd71acc - (5 hours ago) Fix issues with sending direct messages from user profile (#6999) - Emelia Smith
| * 3f51c6ef - (5 hours ago) Weblate translations (2018-04-02) (#7007) - Yamagishi Kazutoshi
| * b04f73ce - (6 hours ago) Russian language updated (#7005) - Evgeny Petrov
| * 24611d8d - (6 hours ago) i18n: update zh-HK translation (#7004) - luzi82
| * f890d2a7 - (16 hours ago) Support all ActivityPub actor types (#6997) - Eugen Rochko
| * 33513753 - (16 hours ago) Fix unpermitted parameters warning when generating pagination URLs (#6995) - Eugen Rochko
| * 123a343d - (19 hours ago) [WIP] Enable custom emoji on account pages and in the sidebar (#6124) - David Underwood
| * f464f98f - (19 hours ago) Update Ruby to version 2.4.4 (#6964) - Yamagishi Kazutoshi
| * 6a895e1a - (20 hours ago) Fix: Prevent submission using same logic as submit button disabling. (#6993) - Emelia Smith
* | 011eda08 - (7 minutes ago) Properly cache requests using service workers - Morgan Bazalgette
* | 8dd77f17 - (5 hours ago) Fix build - Morgan Bazalgette
* | 99373236 - (19 hours ago) Add build status - Morgan Bazalgette
* | b448a3a5 - (19 hours ago) Update README - Morgan Bazalgette
* | 68fd7ee6 - (20 hours ago) Fix statuses embedded in like/boost notifs being white - Morgan Bazalgette
* | 7a9212df - (21 hours ago) Temporary workaround to only show related statuses - Morgan Bazalgette
* |   00bd10fa - (26 hours ago) Merge branch 'master' of github.com:tootsuite/mastodon - Morgan Bazalgette
|\ \
| |/
| * 993ce0e5 - (28 hours ago) improve zh-HK localization by referring zh-TW and zh-CN (#6988) - luzi82
* |   05832497 - (30 hours ago) Merge branch 'master' of github.com:tootsuite/mastodon - Morgan Bazalgette
 \ \
  |/
  * 929f58f1 - (32 hours ago) i18n: Update Polish translation (#6985) - Marcin Mikołajczak
```
2018-04-02 18:31:57 +02:00
config Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into develop 2018-04-02 13:15:38 +02:00
installation nginx: document how to enable CORS support 2018-04-01 01:28:27 -05:00
lib Load all users at once in timelines. 2018-04-02 16:35:41 +02:00
priv Bring mastofe up to date 2018-04-02 18:31:57 +02:00
test Load all users at once in timelines. 2018-04-02 16:35:41 +02:00
.credo.exs Refactor code to comply with credo suggestions 2017-04-27 16:18:50 +03:00
.gitignore Ignore uploads. 2017-03-30 14:34:34 +02:00
.gitlab-ci.yml Make test output easier to read. 2018-02-12 10:14:11 +01:00
LICENSE Add license 2017-04-16 05:37:52 -04:00
mix.exs Add mock. 2018-04-02 13:12:47 +02:00
mix.lock Add mock. 2018-04-02 13:12:47 +02:00
README.md Update README.md 2018-03-10 13:27:10 +00:00
TODO.txt Output proper published data in ostatus. 2017-05-24 13:54:25 +02:00

Pleroma

About Pleroma

Pleroma is an OStatus-compatible social networking server written in Elixir, compatible with GNU Social and Mastodon. It is 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.

Mobile clients that are known to work well:

  • Twidere
  • Tusky
  • Pawoo (Android + iOS)
  • Subway Tooter
  • Amaroq (iOS)
  • Tootdon (Android + iOS)
  • Tootle (iOS)

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.

Installation

Dependencies

  • Postgresql version 9.6 or newer
  • Elixir version 1.5 or newer
  • Build-essential tools

Configuration

  • 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, which you need to run as PostgreSQL superuser (i.e. sudo su postgres -c "psql -f config/setup_db.psql"). It will setup a pleroma db user, database and will setup needed extensions that need to be set up once as superuser.

  • 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/ On Debian you can use certbot package and command to manage letsencrypt certificates.

  • [Not tested with system reboot yet!] You'll also want to set up Pleroma to be run as a systemd service. Example .service file can be found in installation/pleroma.service you can put it in /etc/systemd/system/.

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.

As systemd service (with provided .service file)

Running service pleroma start Logs can be watched by using journalctl -fu pleroma.service

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.

Admin Tasks

Password reset

Run mix generate_password_reset username to generate a password reset link that you can then send to the user.

Moderators

You can make users moderators. They will then be able to delete any post.

Run mix set_moderator username [true|false] to make user a moderator or not.