sam/pleroma
sam/pleroma
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
A froth fork of the federated social media platform. This will not be updated frequently, use at your own peril. https://blog.froth.zone/sam/the-end-of-an-era
14534 commits 2 branches 40 tags 290 MiB
Elixir 97%
HTML 2.2%
CSS 0.4%
Shell 0.3%
Find a file
floatingghost d2a185c013 Documentation updates for stable release (#73) 
Reviewed-on: https://akkoma.dev/AkkomaGang/akkoma/pulls/73
2022-07-15 12:27:16 +00:00
.gitlab release MR template: add a note about merging stable changes back to 2020-08-26 07:09:28 +03:00
.woodpecker Documentation updates for stable release (#73) 2022-07-15 12:27:16 +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 Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
docs Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
installation Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
lib Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
priv Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
rel Remove precompiled javascript (#55) 2022-07-08 13:03:18 +00:00
restarter Merge branch 'develop' into gun 2020-03-07 12:41:37 +03:00
test Pass remote follow avatar into media proxy 2022-07-12 15:44:38 -04: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 Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
.gitlab-ci.yml CI: Fix the broken tasks. 2021-12-26 18:54:54 +01: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 Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
COPYING Relicense documentation under CC-BY-4.0 2021-02-16 13:10:58 +03: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 Bump alpine to 3.14 2021-12-17 18:03:06 -05:00
elixir_buildpack.config Upgrade to Elixir 1.9 2020-06-16 13:18:29 +00:00
Makefile Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
mix.exs Add swaggerUI options (#66) 2022-07-13 15:09:35 +00:00
mix.lock Add swaggerUI options (#66) 2022-07-13 15:09:35 +00:00
Procfile CI: Add auto-deployment via dokku. 2019-05-31 10:55:35 +02:00
README.md Documentation updates for stable release (#73) 2022-07-15 12:27:16 +00:00
SECURITY.md SECURITY.md: update supported versions to only 2.2 2020-10-15 21:45:31 +03:00

README.md

akkoma

a smallish microblogging platform, aka the cooler pleroma

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. Pleroma 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 PostgresSQL for data storage.

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

Installation

OTP releases (Recommended)

If you are running Linux (glibc or musl) on x86, 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.

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

Documentation