AkkomaGang/akkoma
AkkomaGang/akkoma
15
67
Fork 100
Code Issues 181 Pull requests 29 Projects 2 Releases 19 Packages Wiki Activity
Magically expressive social media https://akkoma.social/
15971 commits 28 branches 116 tags 331 MiB
Elixir 96.9%
HTML 2.2%
CSS 0.5%
Shell 0.3%
Find a file
Oneric 066d5b48ed
Some checks failed
ci/woodpecker/push/lint Pipeline was successful
Details
ci/woodpecker/push/test Pipeline was successful
Details
ci/woodpecker/push/build-arm64 Pipeline failed
Details
ci/woodpecker/push/build-amd64 Pipeline failed
Details
ci/woodpecker/push/docs unknown status
Details
Fix Content-Type sanitisation for emoji and local uploads 
This was accidentally broken in c8e0f7848b
due to a one-letter mistake in the plug option name and an absence of
tests. Therefore it was once again possible to serve e.g. Javascript or
CSS payloads via uploads and emoji.
However due to other protections it was still NOT possible for anyone to
serve any payload with an ActivityPub Content-Type. With the CSP policy
hardening from previous JS payload exloits predating the Content-Type
sanitisation, there is currently no known way of abusing this weakened
Content-Type sanitisation, but should be fixed regardless.

This commit fixes the option name and adds tests to ensure
such a regression doesn't occur again in the future.

Reported-by: Lain Soykaf <lain@lain.com>
2025-03-10 19:45:26 +01:00
.gitea/issue_template Update '.gitea/issue_template/feat.yml' 2022-12-12 04:26:43 +00:00
.woodpecker ARM64 2025-01-05 17:23:52 +00:00
benchmarks Benchmarks: fix user timeline and tags benchmarks 2021-12-12 17:35:02 +00:00
ci CI: Use own package as base 2021-12-26 18:05:42 +01:00
config signature: refetch key upon verification failure 2025-02-21 19:37:27 +01:00
diagnostic-tools add diagnostic script 2024-06-10 15:10:47 +01:00
docker-resources Update docker compose commands to Compose V2 2023-06-18 01:37:40 -04:00
docs readme: drop mention of YunoHost package 2025-02-14 22:10:25 +01:00
installation openbsd: update service file 2025-01-03 21:22:38 +01:00
lib Fix Content-Type sanitisation for emoji and local uploads 2025-03-10 19:45:26 +01:00
priv upgrade oban migrations to v12 2025-03-02 11:32:40 +00:00
rel Disable busy waits in the default OTP vm.args configuration. 2024-02-17 13:21:56 +01:00
restarter fix_flaky_transfer_task_test.exs (#237) 2022-11-01 14:31:29 +00:00
scripts document prometheus 2022-12-16 10:24:36 +00:00
test Fix Content-Type sanitisation for emoji and local uploads 2025-03-10 19:45:26 +01:00
uploads fix issues with the uploads directory 2019-04-28 06:43:00 +02:00
.credo.exs Move Consistency.FileLocation to ./test 2020-10-13 19:57:45 +02:00
.dockerignore Docker builds (#231) 2022-10-16 19:25:54 +00:00
.formatter.exs add a snapshot test for api prefixes 2025-02-23 16:51:48 +00:00
.gitattributes Don't treat js/css as binary in git anymore 2022-12-23 18:03:14 +00:00
.gitignore Add docker override file to docs and gitignore 2023-08-07 13:09:04 -04:00
.mailmap Add myself to .mailmap 2021-02-15 13:19:44 +03: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 prepare 2025.03 release 2025-03-01 12:19:43 +00:00
CODE_OF_CONDUCT.md add code of conduct (#129) 2022-08-03 10:55:11 +00:00
COPYING Remove reference to city.jpg in COPYING 2022-11-25 07:29:50 +00:00
docker-compose.yml Merge pull request 'Add docker override file to docs and gitignore' (#621) from norm/akkoma:docker-compose-override into develop 2024-04-12 18:50:25 +00:00
docker-entrypoint.sh Fix busywait on docker-entrypoint script 2024-08-20 19:29:11 -03:00
Dockerfile Bump builds to OTP26 2023-08-09 14:39:28 +01:00
FEDERATION.md Merge branch 'develop' of https://akkoma.dev/AkkomaGang/akkoma into use_fep-c16b_formatting_mfm_functions 2025-02-23 10:13:44 +01:00
mix.exs bump version 2025-03-01 16:36:04 +00:00
mix.lock dependency upgrade 2025-03-02 11:34:09 +00:00
README.md readme: drop mention of YunoHost package 2025-02-14 22:10:25 +01:00
SECURITY.md Update notes on security exploit handling 2024-03-04 17:50:19 +01:00
SIGNING_KEY.pub 2022.09 stable release chores (#206) 2022-09-10 14:44:17 +00:00

README.md

akkoma

a smallish microblogging platform, aka the cooler pleroma

English OK 日本語OK

About

This is a fork of Pleroma, which 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. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.

Akkoma is written in Elixir and uses PostgreSQL for data storage.

For clients it supports the Mastodon client API with Pleroma extensions (see the API section on https://docs.akkoma.dev/stable/).

Differences with Pleroma

Akkoma is a faster-paced fork, it has a varied and potentially experimental feature set tailored specifically to the corner of the fediverse inhabited by the project creator and contributors.

This should not be considered a one-for-one match with pleroma; it is more opinionated in many ways, and has a smaller community (which is good or bad depending on your view)

For example, Akkoma has:

  • Custom Emoji reactions (compatible with misskey)
  • Misskey-flavoured markdown support
  • Elasticsearch and Meilisearch support for search
  • Mastodon frontend (Glitch-Soc and Fedibird flavours) support
  • Automatic post translation via DeepL or LibreTranslate
  • A multitude of heavy modifications to the Pleroma Frontend (Pleroma-FE)
  • The "bubble" concept, in which instance administrators can choose closely-related instances to make a "community of communities", so to say

And takes a more opinionated stance on issues like Domain blocks, which are enforced far more on Akkoma.

Take a look at the Changelog if you want a full list of recent changes, everything since 3.0 has been Akkoma.

Installation

OTP releases (Recommended)

If you are running Linux (glibc or musl) on x86, the recommended way to install Akkoma 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 Akkoma from source.

Docker

Docker installation is supported via this setup

Compilation Troubleshooting

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

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

Documentation