sn0w/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 [cold edition]
8437 commits 13 branches 64 tags 302 MiB
Elixir 97%
HTML 2.3%
CSS 0.4%
Shell 0.2%
Find a file
rinpatch 6471c09372 Merge branch 'docs_cheatsheet' into 'develop' 
DOCS Add warning for fetch_initial_posts + more explicit distinction between OTP and from source

See merge request pleroma/pleroma!2262
2020-03-01 19:16:54 +00:00
benchmarks Add benchmark of any/all tag options 2020-01-20 12:19:15 +01:00
config timeline controller: rate limit timelines to 3 requests per 500ms per timeline per ip/user 2020-03-01 01:13:08 +03:00
docs Add warning to the fetch_initial_posts setting. Now we sometimes have people who enable this without realising the consequences (tons of posts being fetcht as each fetch makes Pleroma discover new users) 2020-03-01 19:16:54 +00:00
installation Add remote_ip plug 2019-09-27 21:59:23 +00:00
lib timeline controller: add a TODO for replacing copypaste with a macro 2020-03-01 02:03:46 +03:00
priv MastoFE: Bundle 2020-01-20 2020-02-29 06:41:13 +01:00
rel OTP releases: only set name and distribution type if not set already 2019-11-22 19:58:39 +03:00
restarter need_reboot flag 2020-02-08 13:00:02 +03:00
test rate limiter: Fix a race condition 2020-03-01 01:13:07 +03: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 remove docs/ from .dockerignore 2019-11-20 00:09:07 +09:00
.formatter.exs HTML: Compile Scrubbers on boot 2019-12-08 20:35:41 +03:00
.gitattributes .gitattributes: use native support for elixir definitions 2020-02-17 13:27:28 +03:00
.gitignore Revert "Merge branch 'revert-4fabf83a' into 'develop'" 2019-09-16 17:55:04 +07:00
.gitlab-ci.yml Update docker release / stable jobs 2020-01-15 17:25:33 -05: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 changelog: entries for timeline DoS fixes 2020-03-01 01:13:08 +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 Update Dockerfile with labels. Update gitlab-ci for registry usage 2020-01-10 14:09:14 -05:00
elixir_buildpack.config CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
mix.exs deps: update cachex to 3.2.0 2020-02-29 20:40:23 +03:00
mix.lock deps: update cachex to 3.2.0 2020-02-29 20:40:23 +03:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md readme: replace banner logo with the one using paths for text 2019-11-10 00:52:04 +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.

Documentation

Community Channels