git.squeep.com Git - akkoma/blob - README.md

   1 ## akkoma
   2
   3 *a smallish microblogging platform, aka the cooler pleroma*
   4
   5 ### Why though?
   6
   7 pleroma as a project has stagnated of late. after a spat between
   8 developers led to a fork (which died due to chronic lack of direction),
   9 nearly nobody seems to _want_ to work on it. this in addition to the
  10 BDFL being AWOL whenever needed, means that the entire project is
  11 nought but a power vacuum waiting for someone to step in. and with the
  12 track record pleroma has, i do not trust that whoever steps in will be
  13 good for the project.
  14
  15 thus, i am striking out on my own. i already had a few modifications
  16 on my instance, so it wasn't a particularly large leap to assume direct
  17 control.
  18
  19 ### But really, why should I migrate to your thing?
  20
  21 aside from me actually being responsive? let's lookie here, we've got
  22 - custom emoji reactions
  23 - misskey markdown (MFM) rendering and posting support
  24 - elasticsearch support (because pleroma search is GARBAGE)
  25 - latest develop pleroma-fe additions
  26 - local-only posting
  27 - probably more, this is like 3.5 years of IHBA additions finally compiled
  28
  29 ## Upgrading to Akkoma
  30
  31 ### From source
  32
  33 ```bash
  34 git remote set-url origin https://akkoma.dev/AkkomaGang/akkoma.git/
  35 git fetch origin
  36 git pull -r
  37 ```
  38
  39 Then compile, migrate and restart as usual.
  40
  41 Then if you've done anything fancy to the frontend, you'll want to get the
  42 updates for that as well. This won't be the same for any two instances,
  43 so `https://akkoma.dev/AkkomaGang/pleroma-fe` is the repo you need.
  44
  45 ### From OTP
  46
  47 ```bash
  48 export FLAVOUR=$(arch="$(uname -m)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;fi;echo "$arch$libc_postfix")
  49
  50 ./bin/pleroma_ctl update --zip-url https://akkoma-updates.s3-website.fr-par.scw.cloud/develop/akkoma-$FLAVOUR.zip
  51 ./bin/pleroma_ctl migrate
  52 ```
  53
  54 Then restart. When updating in the future, can just use
  55
  56 ```bash
  57 ./bin/pleroma_ctl update --branch develop
  58 ```
  59
  60 ### Old readme follows
  61
  62 <img src="https://git.pleroma.social/pleroma/pleroma/uploads/8cec84f5a084d887339f57deeb8a293e/pleroma-banner-vector-nopad-notext.svg" width="300px" />
  63
  64 ## About
  65
  66 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.
  67
  68 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).
  69
  70 For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs-develop.pleroma.social>).
  71
  72 - [Client Applications for Pleroma](https://docs-develop.pleroma.social/backend/clients/)
  73
  74 ## Installation
  75
  76 ### OTP releases (Recommended)
  77 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](https://docs-develop.pleroma.social/backend/installation/otp_en/).
  78
  79 ### From Source
  80 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.
  81
  82 - [Alpine Linux](https://docs-develop.pleroma.social/backend/installation/alpine_linux_en/)
  83 - [Arch Linux](https://docs-develop.pleroma.social/backend/installation/arch_linux_en/)
  84 - [CentOS 7](https://docs-develop.pleroma.social/backend/installation/centos7_en/)
  85 - [Debian-based](https://docs-develop.pleroma.social/backend/installation/debian_based_en/)
  86 - [Debian-based (jp)](https://docs-develop.pleroma.social/backend/installation/debian_based_jp/)
  87 - [FreeBSD](https://docs-develop.pleroma.social/backend/installation/freebsd_en/)
  88 - [Gentoo Linux](https://docs-develop.pleroma.social/backend/installation/gentoo_en/)
  89 - [NetBSD](https://docs-develop.pleroma.social/backend/installation/netbsd_en/)
  90 - [OpenBSD](https://docs-develop.pleroma.social/backend/installation/openbsd_en/)
  91 - [OpenBSD (fi)](https://docs-develop.pleroma.social/backend/installation/openbsd_fi/)
  92
  93 ### OS/Distro packages
  94 Currently Pleroma is packaged for [YunoHost](https://yunohost.org). If you want to package Pleroma for any OS/Distros, we can guide you through the process on our [community channels](#community-channels). If you want to change default options in your Pleroma package, please **discuss it with us first**.
  95
  96 ### Docker
  97 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>.
  98
  99 ### Raspberry Pi
 100 Community maintained Raspberry Pi image that you can flash and run Pleroma on your Raspberry Pi. Available here <https://github.com/guysoft/PleromaPi>.
 101
 102 ### Compilation Troubleshooting
 103 If you ever encounter compilation issues during the updating of Pleroma, you can try these commands and see if they fix things:
 104
 105 - `mix deps.clean --all`
 106 - `mix local.rebar`
 107 - `mix local.hex`
 108 - `rm -r _build`
 109
 110 If you are not developing Pleroma, it is better to use the OTP release, which comes with everything precompiled.
 111
 112 ## Documentation
 113 - Latest Released revision: <https://docs.pleroma.social>
 114 - Latest Git revision: <https://docs-develop.pleroma.social>
 115
 116 ## Community Channels
 117 * IRC: **#pleroma** and **#pleroma-dev** on libera.chat, webchat is available at <https://irc.pleroma.social>
 118 * Matrix: [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) and [#pleroma-dev:libera.chat](https://matrix.to/#/#pleroma-dev:libera.chat)