-# 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 and the Mastodon client API.
+## 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)
+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 https://matrix.heldscal.la/#/room/#pleromafe:matrix.heldscal.la.
+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
-
-### Dependencies
-
-* Postgresql version 9.6 or newer
-* Elixir version 1.4 or newer
-* Build-essential tools
-
-#### Installing dependencies on Debian system
-PostgreSQL 9.6 should be available on Debian stable (Jessie) from "main" area. Install it using apt: `apt install postgresql-9.6`. Make sure that older versions are not installed since Debian allows multiple versions to coexist but still runs only one version.
-
-You must install elixir 1.4+ from elixir-lang.org, because Debian repos only have 1.3.x version. You will need to add apt repo to sources.list(.d) and import GPG key. Follow instructions here: https://elixir-lang.org/install.html#unix-and-unix-like (See "Ubuntu or Debian 7"). This should be valid until Debian updates elixir in their repositories. Package you want is named `elixir`, so install it using `apt install elixir`
-
-Elixir will also require `make` and probably other related software for building dependencies - in case you don't have them, get them via `apt install build-essential`
+- [Client Applications for Akkoma](https://docs.akkoma.dev/stable/clients/)
-### Preparation
+## Differences with Pleroma
- * You probably want application to run as separte user - so create a new one: `adduser pleroma`, you can login as it via `su pleroma`
- * Clone the git repository into new user's dir (clone as the pleroma user to avoid permissions errors)
- * Again, as new user, install dependencies with `mix deps.get` if it asks you to install "hex" - agree to that.
+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.
-### Database setup
+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)
- * Create a database user and database for pleroma
- * Open psql shell as postgres user: (as root) `su postgres -c psql`
- * Create a new PostgreSQL user:
+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
- ```sql
- \c pleroma_dev
- CREATE user pleroma;
- ALTER user pleroma with encrypted password '<your password>';
- GRANT ALL ON ALL tables IN SCHEMA public TO pleroma;
- GRANT ALL ON ALL sequences IN SCHEMA public TO pleroma;
- ```
+And takes a more opinionated stance on issues like Domain blocks, which are enforced far more on Akkoma.
- * Create `config/dev.secret.exs` and copy the database settings from `dev.exs` there.
- * Change password in `config/dev.secret.exs`, and change user to `"pleroma"` (line like `username: "postgres"`)
- * Create and update your database with `mix ecto.create && mix ecto.migrate`.
+Take a look at the Changelog if you want a full list of recent changes, everything since 3.0 has been Akkoma.
-### Some additional configuration
-
- * You will need to let pleroma instance to know what hostname/url it's running on. _THIS IS THE MOST IMPORTANT STEP. GET THIS WRONG AND YOU'LL HAVE TO RESET YOUR DATABASE_. We _ONLY_ support _HTTPS_ deployments in production. You can use basic http for local dev, but _NEVER USE IT_ on an actual instance.
-
- Create the file `config/dev.secret.exs`, add these lines at the end of the file:
-
- ```elixir
- config :pleroma, Pleroma.Web.Endpoint,
- url: [host: "example.tld", scheme: "https", port: 443]
- ```
-
- replacing `example.tld` with your (sub)domain
-
- * You should also setup your site name and admin email address. Look at config.exs for more available options.
+## Installation
- ```elixir
- config :pleroma, :instance,
- name: "My great instance",
- email: "someone@example.com"
- ```
+### 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