-# Pleroma
+## akkoma
-## About Pleroma
+*a smallish microblogging platform, aka the cooler pleroma*
-Pleroma is an OStatus-compatible social networking server written in Elixir, compatible with GNU Social and Mastodon. It is high-performance and can run on small devices like a Raspberry Pi.
+ 
-For clients it supports both the [GNU Social API with Qvitter extensions](https://twitter-api.readthedocs.io/en/latest/index.html) and the [Mastodon client API](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md).
+## About
-Mobile clients that are known to work well:
+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.
-* Twidere
-* Tusky
-* Pawoo (Android + iOS)
-* Subway Tooter
-* Amaroq (iOS)
-* Tootdon (Android + iOS)
+Akkoma is written in Elixir and uses PostgreSQL for data storage.
-No release has been made yet, but several servers have been online for months already. If you want to run your own server, feel free to contact us at @lain@pleroma.soykaf.com or in our dev chat at #pleroma on freenode or via matrix at https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org.
+For clients it supports the [Mastodon client API](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs.akkoma.dev/stable/>).
-## Installation
+- [Client Applications for Akkoma](https://docs.akkoma.dev/stable/clients/)
+
+## Differences with Pleroma
-### Dependencies
+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.
-* Postgresql version 9.6 or newer
-* Elixir version 1.4 or newer (you will also need erlang-dev, erlang-parsetools, erlang-xmerl packages)
-* Build-essential tools
+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)
-### Configuration
+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
- * Run `mix deps.get` to install elixir dependencies.
+And takes a more opinionated stance on issues like Domain blocks, which are enforced far more on Akkoma.
- * Run `mix generate_config`. This will ask you a few questions about your instance and generate a configuration file in `config/generated_config.exs`. Check that and copy it to either `config/dev.secret.exs` or `config/prod.secret.exs`. It will also create a `config/setup_db.psql`, which you need to run as PostgreSQL superuser (i.e. `sudo su postgres -c "psql -f config/setup_db.psql"`). It will setup a pleroma db user, database and will setup needed extensions that need to be set up once as superuser.
+Take a look at the Changelog if you want a full list of recent changes, everything since 3.0 has been Akkoma.
- * Run `mix ecto.migrate` to run the database migrations. You will have to do this again after certain updates.
+## Installation
- * You can check if your instance is configured correctly by running it with `mix phx.server` and checking the instance info endpoint at `/api/v1/instance`. If it shows your uri, name and email correctly, you are configured correctly. If it shows something like `localhost:4000`, your configuration is probably wrong, unless you are running a local development setup.
+### 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](https://docs.akkoma.dev/stable/installation/otp_en/).
- * The common and convenient way for adding HTTPS is by using Nginx as a reverse proxy. You can look at example Nginx configuration in `installation/pleroma.nginx`. If you need TLS/SSL certificates for HTTPS, you can look get some for free with letsencrypt: https://letsencrypt.org/
- On Debian you can use `certbot` package and command to manage letsencrypt certificates.
+### 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.
- * [Not tested with system reboot yet!] You'll also want to set up Pleroma to be run as a systemd service. Example .service file can be found in `installation/pleroma.service` you can put it in `/etc/systemd/system/`.
+- [Alpine Linux](https://docs.akkoma.dev/stable/installation/alpine_linux_en/)
+- [Arch Linux](https://docs.akkoma.dev/stable/installation/arch_linux_en/)
+- [Debian-based](https://docs.akkoma.dev/stable/installation/debian_based_en/)
+- [FreeBSD](https://docs.akkoma.dev/stable/installation/freebsd_en/)
+- [Gentoo Linux](https://docs.akkoma.dev/stable/installation/gentoo_en/)
+- [NetBSD](https://docs.akkoma.dev/stable/installation/netbsd_en/)
+- [OpenBSD](https://docs.akkoma.dev/stable/installation/openbsd_en/)
-## Running
+### Docker
+Docker installation is supported via [this setup](https://docs.akkoma.dev/stable/installation/docker_en/)
-By default, it listens on port 4000 (TCP), so you can access it on http://localhost:4000/ (if you are on the same machine). In case of an error it will restart automatically.
+### Compilation Troubleshooting
+If you ever encounter compilation issues during the updating of Akkoma, you can try these commands and see if they fix things:
-### As systemd service (with provided .service file)
-Running `service pleroma start`
-Logs can be watched by using `journalctl -fu pleroma.service`
+- `mix deps.clean --all`
+- `mix local.rebar`
+- `mix local.hex`
+- `rm -r _build`
-### Standalone/run by other means
-Run `mix phx.server` in repository's root, it will output log into stdout/stderr
+## Documentation
+- https://docs.akkoma.dev/stable
+- https://docs.akkoma.dev/develop
projects / akkoma / blobdiff