ash/akkoma
1
0
Fork 0
forked from AkkomaGang/akkoma
Code Issues Pull requests Projects Releases Packages Wiki Activity
Magically expressive social media
10685 commits 6 branches 74 tags 292 MiB
Elixir 97.3%
HTML 2.2%
Shell 0.2%
CSS 0.2%
Find a file
rinpatch 58a4f350a8 Refactor gun pooling and simplify adapter option insertion 
This patch refactors gun pooling to use Elixir process registry and
simplifies adapter option insertion.

Having the pool use process registry instead of a GenServer has a number of advantages:
- Simpler code: the initial implementation adds about half the lines of code it deletes
- Concurrency: unlike a GenServer, ETS-based registry can handle multiple checkout/checkin
requests at the same time
- Precise and easy idle connection clousure: current proposal for closing idle connections in
the GenServer-based pool needs to filter through all connections once a minute and compare their
last active time with closing time. With Elixir process registry this can be done
by just using `Process.send_after`/`Process.cancel_timer` in the worker process.
- Lower memory footprint: In my tests `gun-memory-leak` branch uses about 290mb on peak load (250 connections)
and 235mb on idle (5-10 connections). Registry-based pool uses 210mb on idle and 240mb on peak load
2020-07-15 15:17:27 +03:00
.gitlab Use correct PostgreSQL version command in bug template 2020-06-30 03:12:30 +00:00
benchmarks adding benchmarks in new format 2020-07-06 09:30:42 +03:00
config Refactor gun pooling and simplify adapter option insertion 2020-07-15 15:17:27 +03:00
docs Merge branch 'feature/1922-media-proxy-whitelist' into 'develop' 2020-07-14 18:07:44 +00:00
installation Merge branch 'develop' into issue/1855 2020-06-15 15:24:55 +03:00
lib Refactor gun pooling and simplify adapter option insertion 2020-07-15 15:17:27 +03:00
priv Merge branch '1940-admin-token-oauthless-auth' into 'develop' 2020-07-14 16:48:26 +00: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 Merge branch 'tests/apc2s-update_outbox' into 'develop' 2020-07-15 10:12:44 +00: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 Support Exiftool for stripping EXIF data 2020-07-10 16:46:26 -05:00
.gitlab-ci.yml Support Exiftool for stripping EXIF data 2020-07-10 16:46:26 -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 Merge branch 'feature/1922-media-proxy-whitelist' into 'develop' 2020-07-14 18:07:44 +00:00
COPYING Bump copyright dates. 2020-03-26 15:37:42 +01:00
coveralls.json tests for emoji mix task 2020-04-06 11:13:59 +03:00
docker-entrypoint.sh Create docker.exs and docker-entrypoint + round out Dockerfile 2019-08-03 00:21:54 -04:00
Dockerfile Support Exiftool for stripping EXIF data 2020-07-10 16:46:26 -05:00
elixir_buildpack.config Upgrade to Elixir 1.9 2020-06-16 13:18:29 +00:00
mix.exs Fix in-db configuration in dev environment 2020-07-14 13:16:54 +03:00
mix.lock Merge branch 'develop' into issue/1790-updated-oban 2020-07-10 11:34:53 -05:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md README: Add some troubleshooting info for compilation issues. 2020-06-19 15:49:34 +02: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