ShariVegas/akkoma
1
0
Fork 0
forked from AkkomaGang/akkoma
Code Issues Pull requests Projects Releases Packages Wiki Activity
A place of adventure, a place of danger, a place of excitement
7430 commits 14 branches 60 tags 272 MiB
Elixir 97.2%
HTML 2.2%
Shell 0.3%
CSS 0.2%
Find a file
rinpatch 96da25c92f Partial readme rewrite 
Remove the outdated generic installation guide and point to
platform-specific ones instead, update contact info, protocols we
support, etc.
2019-11-09 22:01:25 +03:00
benchmarks Fix benchmarks 2019-10-21 15:55:28 +07:00
config Bump fast_sanitize to 0.1.1 2019-11-08 00:51:04 +03:00
docs Mastodon API: Add the recipients parameter to GET /api/v1/conversations 2019-11-07 08:26:24 +03:00
installation Add remote_ip plug 2019-09-27 21:59:23 +00:00
lib object containment: handle all cases where ID is invalid (missing, nil, non-string) 2019-11-08 14:51:28 -06:00
priv Bump pleroma-fe bundle to 044c9ad0562af059dd961d50961a3880fca9c642 2019-11-09 01:49:36 +03:00
rel pleroma_ctl: fix crashes due to different shift(1) behavior on dash 2019-10-24 23:28:59 +03:00
test object containment: handle all cases where ID is invalid (missing, nil, non-string) 2019-11-08 14:51:28 -06: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 [Credo][CI] Add readability as it’s fixed 2019-03-13 04:26:56 +01:00
.dockerignore Add .dockerignore 2019-08-03 00:21:54 -04:00
.formatter.exs Enable mix format for migrations 2019-10-08 15:16:39 +03:00
.gitignore Revert "Merge branch 'revert-4fabf83a' into 'develop'" 2019-09-16 17:55:04 +07:00
.gitlab-ci.yml CI: Remove the docs-build job 2019-11-05 23:45:07 +03: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-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 Mastodon API: Add the recipients parameter to GET /api/v1/conversations 2019-11-07 08:26:24 +03:00
COPYING pleroma-fox-tan-shy.png: Add another version of pleroma-tan 2019-05-12 05:09:15 +02:00
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 2019-08-03 00:21:54 -04:00
Dockerfile Switch to alpine:3.9 to avoid dlsym errors 2019-09-04 14:56:26 -04:00
elixir_buildpack.config CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
mix.exs Bump fast_sanitize to 0.1.1 2019-11-08 00:51:04 +03:00
mix.lock Bump fast_sanitize 2019-11-08 22:22:54 +03:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md Partial readme rewrite 2019-11-09 22:01:25 +03:00

README.md

Pleroma

About Pleroma

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, it is easily administered via the provided shell script to open up a remote console, start/stop/restart the release, start in the background, send remote commands, and more. 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.

Documentation

Community Channels