akkoma/README.md

## What is this?

This is a fork of [AkkomaGang/akkoma](https://akkoma.dev/AkkomaGang/akkoma/), with some opinionated changes to satisfy my needs.

The main differences between this and the upstream repository are

- Uses the official Elixir image from Docker Hub
- Automatically builds the Akkoma backend when building the Docker image, instead of requiring complex commands after pulling/building images
- Files/directories to mount are minified and completely separated from the repository files, allowing better control over file permissions
- Has an actual Docker entry point, rather than a command that pretends to be an entry point
- Includes out-of-the-box support for [PGroonga](https://pgroonga.github.io/), the fast and accurate full-text search extension for PostgreSQL
- Supports Podman quite well

## How to setup (Podman Rootless)

_You don't need to replicate backslashes followed by line breaks. They mean "Ignore the next line break" and are only used for better readability. `a \<line break> b \<line break> c` is the same as `a b c`._

### 0. Requirements

- A decent CPU
- 2GB of memory (200MB runtime)
- 500MB free disk space
- Podman runs as non-root user

### 1. Build your image

This will take 5+ minutes.

```sh
cd /YOUR/GIT/DIRECTORY/akkoma/
podman build -t akkoma .
```

### 2. Create a Podman Pod for Akkoma

```sh
podman pod create \
  --publish YOUR_PORT:4000 \
  akkoma
```

You can use **pasta(1)** if you want to preserve incoming IPs and easily access the host machine through the network gateway.

```sh
podman pod create \
  --network pasta:--map-gw,-a,10.0.2.0,-n,24,-g,10.0.2.1 \
  --add-host gateway:10.0.2.1 \
  --publish YOUR_PORT:4000 \
  akkoma
```

### 3. Setting up the database

```sh
podman run -d \
  --pod akkoma \
  --restart unless-stopped \
  --name akkoma-db \
  -e POSTGRES_DB=YOUR_DB_NAME \
  -e POSTGRES_USER=YOUR_DB_USER \
  -e POSTGRES_PASSWORD=YOUR_DB_PASS \
  -v ${PWD}/docker-db/:/var/lib/postgresql/data/:Z \
  postgres:14-alpine
```

If you want to use PGroonga, run the command below instead.

```sh
podman run -d \
  --pod akkoma \
  --restart unless-stopped \
  --name akkoma-db \
  -e POSTGRES_DB=YOUR_DB_NAME \
  -e POSTGRES_USER=YOUR_DB_USER \
  -e POSTGRES_PASSWORD=YOUR_DB_PASS \
  -v ${PWD}/docker-db/:/var/lib/postgresql/data/:Z \
  groonga/pgroonga:3.1.1-alpine-14
```

### 4. Setting up the backend

```sh
podman run -d \
  --pod akkoma-pod \
  --restart unless-stopped \
  --name akkoma-web \
  -e DB_NAME=YOUR_DB_NAME \
  -e DB_USER=YOUR_DB_USER \
  -e DB_PASS=YOUR_DB_PASS \
  -v ${PWD}/static/:/var/lib/akkoma/static/:Z \
  -v ${PWD}/uploads/:/var/lib/akkoma/uploads/:Z \
  -v ${PWD}/etc/:/etc/akkoma/:Z \
  akkoma

podman exec -it akkoma-web \
  pleroma_ctl \
  instance gen \
  --output /etc/akkoma/config.exs
```

A few notes on setup

- Make sure your database hostname is set correctly (e.g. localhost)
- Make sure your database password is also set correctly (don't leave it auto-generated)
- You should set the IP to listen on to 0.0.0.0

### 4.1. Apply the optional PGroonga migration

Make sure you apply the migration **before** the first restart of the container, otherwise you will be stuck in a loop of restarts.

_To apply the migration after the first restart, please refer to [the guide down below](#switch-to-pgroonga)._

```sh
podman exec -it akkoma-web \
  pleroma_ctl \
  migrate \
  --migrations-path priv/repo/optional_migrations/pgroonga
```

You can revert the applied changes at any time by replacing `migrate` with `rollback`.

### 5. Test your setup

```sh
podman restart akkoma-web
curl -I http://localhost:YOUR_PORT/
```

You should see `HTTP/1.1 200 OK`.

### 6. Setting up the frontend

```sh
podman exec -it akkoma-web \
  pleroma_ctl \
  frontend install \
  pleroma-fe
```

```sh
podman exec -it akkoma-web \
  pleroma_ctl \
  frontend install \
  admin-fe
```

### 7. Create your first user

```sh
podman exec -it akkoma-web \
  pleroma_ctl \
  user new \
  YOUR_NAME \
  YOUR@EMAIL.EXAMPLE \
  --admin
```

Follow the printed link to set your password.

### 8. Optional steps

#### Switch to PGroonga

Before moving forward, make sure you have stopped the backend for safety.

```sh
podman stop akkoma-web
```

After stopping the backend, change `config :pleroma, :database, pgroonga_enabled` to `true`.

```ex
config :pleroma, :database,
  rum_enabled: false,
  pgroonga_enabled: true # set this option to true
```

If you have command history enabled in your shell, all you need to do is remove the `--name NAME` option and add `pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/pgroonga` to the end of the command.

```sh
podman run -d \
  --pod akkoma-pod \
  --restart unless-stopped \ # this option is optional (bruh)
  # --name akkoma-web \ # make sure to remove this option to avoid name conflict
  -e DB_NAME=YOUR_DB_NAME \
  -e DB_USER=YOUR_DB_USER \
  -e DB_PASS=YOUR_DB_PASS \
  -v ${PWD}/static/:/var/lib/akkoma/static/:Z \
  -v ${PWD}/uploads/:/var/lib/akkoma/uploads/:Z \
  -v ${PWD}/etc/:/etc/akkoma/:Z \
  akkoma \
  pleroma_ctl \
  migrate \
  --migrations-path priv/repo/optional_migrations/pgroonga
```

You can revert the applied changes anytime by replacing `migrate` with `rollback`.

Don't forget to start the container you stopped at the beginning of this guide.

```sh
podman start akkoma-web
```

---

## Akkoma

_a smallish microblogging platform, aka the cooler pleroma_

![English OK](https://img.shields.io/badge/English-OK-blueviolet?style=for-the-badge) ![日本語OK](https://img.shields.io/badge/%E6%97%A5%E6%9C%AC%E8%AA%9E-OK-blueviolet?style=for-the-badge)

## 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](https://docs.joinmastodon.org/api/guidelines/) with Pleroma extensions (see the API section on <https://docs.akkoma.dev/stable/>).

- [Client Applications for Akkoma](https://docs.akkoma.dev/stable/clients/)

## 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](https://docs.akkoma.dev/stable/installation/otp_en/).

### 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.

- [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/)

### Docker

Docker installation is supported via [this setup](https://docs.akkoma.dev/stable/installation/docker_en/)

### Packages

Akkoma is packaged for [YunoHost](https://yunohost.org) and can be found and installed from the [YunoHost app catalogue](https://yunohost.org/#/apps).

### 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

- https://docs.akkoma.dev/stable
- https://docs.akkoma.dev/develop