hj/pleroma
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
12898 commits 1 branch 0 tags 218 MiB
Elixir 97.5%
HTML 1.9%
Shell 0.2%
CSS 0.2%
Find a file
Henry Jameson 697397e2b8 Merge remote-tracking branch 'origin/develop' into shigusegubu 
* origin/develop: (145 commits)
  CHANGELOG.md: Remove wrong entries from Unreleased(patch)
  Only run one attachment cleanup job per node
  Just validate command is in PATH; forking a shell is wasteful
  Linting.
  Pbkdf2: Use it everywhere.
  Password -> Password.Pbkdf2
  Linting
  Password: Replace Pbkdf2 with Password.
  Password: Add password module
  COPYING: Bump copyright to 2021
  Bump Copyright to 2021
  Pagination: Don't be dos'd by random parameters.
  Simplify. We will always have a result from Upload.base_url/0, so just add it to the list
  Fix regression in MediaProxy.local?/0 and appending the Upload.base_url to whitelisted domains
  ChatMessages: Fix pagination headers.
  Formatting
  .formatter.exs: Format optional migrations
  Add development section
  Apply 4 suggestion(s) to 2 file(s)
  Move construction of S3 base URL with optional namespace and bucket to Upload.base_url/0
  ...
2021-01-18 04:04:27 +02:00
.gitlab release MR template: add a note about merging stable changes back to 2020-08-26 07:09:28 +03:00
benchmarks Pbkdf2: Use it everywhere. 2021-01-14 15:06:16 +01:00
config Merge remote-tracking branch 'origin/develop' into shigusegubu 2021-01-18 04:04:27 +02:00
docs Add development section 2021-01-10 08:25:36 +00:00
installation Merge remote-tracking branch 'origin/develop' into shigusegubu 2021-01-18 04:04:27 +02:00
lib Merge branch 'optimize-command_available' into 'develop' 2021-01-15 04:44:58 +00:00
priv Bump Copyright to 2021 2021-01-13 07:49:50 +01:00
rel OTP releases: only set name and distribution type if not set already 2019-11-22 19:58:39 +03:00
restarter Merge branch 'develop' into gun 2020-03-07 12:41:37 +03:00
test Linting. 2021-01-14 16:01:14 +01:00
uploads fix issues with the uploads directory 2019-04-28 06:43:00 +02:00
.buildpacks CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
.credo.exs Move Consistency.FileLocation to ./test 2020-10-13 19:57:45 +02:00
.dockerignore remove docs/ from .dockerignore 2019-11-20 00:09:07 +09:00
.formatter.exs .formatter.exs: Format optional migrations 2021-01-10 11:28:41 +03:00
.gitattributes [#3112] .gitattributes fix. 2020-12-09 18:43:20 +03:00
.gitignore Add development section 2021-01-10 08:25:36 +00:00
.gitlab-ci.yml Gitlab-CI: Explicitly tag specified arm32 images. 2020-11-27 13:27:35 +01:00
.mailmap add mailmap [ci skip] 2019-07-11 08:57:51 +00:00
AGPL-3 LICENSE → AGPL-3 2019-04-01 00:31:21 +02:00
CC-BY-4.0 Add a copy of CC-BY-4.0 to the repo 2020-09-06 11:38:38 +03:00
CC-BY-SA-4.0 CC-BY-SA-4.0: Add a copy of the CC-BY-SA-4.0 license 2019-04-01 00:30:21 +02:00
CHANGELOG.md CHANGELOG.md: Remove wrong entries from Unreleased(patch) 2021-01-17 15:55:33 +03:00
COPYING COPYING: Bump copyright to 2021 2021-01-13 07:53:44 +01:00
coveralls.json exclude file_location check from coveralls 2020-10-13 16:44:01 +03:00
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 2019-08-03 00:21:54 -04:00
Dockerfile Merge branch 'libmagic' into 'develop' 2020-11-21 18:11:58 +00:00
elixir_buildpack.config Upgrade to Elixir 1.9 2020-06-16 13:18:29 +00:00
mix.exs Password: Replace Pbkdf2 with Password. 2021-01-13 15:11:11 +01:00
mix.lock Switch to local fork of crypt until upstream fixes ability to build on aarch64 2020-12-28 17:52:18 -06:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md Add FreeBSD and alpha sort 2020-09-22 07:26:31 -05:00
SECURITY.md SECURITY.md: update supported versions to only 2.2 2020-10-15 21:45:31 +03:00

README.md

About

Pleroma is a microblogging server software that can federate (= exchange messages with) other servers that support 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 ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.

Pleroma is written in Elixir and uses PostgresSQL for data storage. It's efficient enough to be ran on low-power devices like Raspberry Pi (though we wouldn't recommend storing the database on the internal SD card ;) but can scale well when ran on more powerful hardware (albeit only single-node for now).

For clients it supports the Mastodon client API with Pleroma extensions (see the API section on https://docs-develop.pleroma.social).

Installation

OTP releases (Recommended)

If you are running Linux (glibc or musl) on x86/arm, the recommended way to install Pleroma is by using OTP releases. OTP releases are as close as you can get to binary releases with Erlang/Elixir. The release is self-contained, and provides everything needed to boot it. The installation instructions are available here.

From Source

If your platform is not supported, or you just want to be able to edit the source code easily, you may install Pleroma from source.

OS/Distro packages

Currently Pleroma is not packaged by any OS/Distros, but if you want to package it for one, we can guide you through the process on our community channels. If you want to change default options in your Pleroma package, please discuss it with us first.

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://glitch.sh/sn0w/pleroma-docker.

Compilation Troubleshooting

If you ever encounter compilation issues during the updating of Pleroma, you can try these commands and see if they fix things:

  • mix deps.clean --all
  • mix local.rebar
  • mix local.hex
  • rm -r _build

If you are not developing Pleroma, it is better to use the OTP release, which comes with everything precompiled.

Documentation

Community Channels