From 320def023b764309d47222d2e412d8664b6b8dfc Mon Sep 17 00:00:00 2001 From: itepechi <72330683+itepechi@users.noreply.github.com> Date: Sun, 30 Jul 2023 00:47:22 +0900 Subject: [PATCH] Add an explanation of the repository --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e4aa25715..aaf9dc1bd 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,24 @@ +## What is This? + +This is a fork of [AkkomaGang/akkoma](https://akkoma.dev/AkkomaGang/akkoma/), with an opinionated Docker setup. + +The differences between the upstream repository are described below: + +- 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 a better Docker entry point where you can control the backend without using pre-written shell scripts +- Supports Podman quite well + +--- + ## akkoma *a smallish microblogging platform, aka the cooler pleroma* -![English OK](https://img.shields.io/badge/English-OK-blueviolet) ![日本語OK](https://img.shields.io/badge/%E6%97%A5%E6%9C%AC%E8%AA%9E-OK-blueviolet) +![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 +## 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. @@ -23,6 +37,7 @@ This should not be considered a one-for-one match with pleroma; it is more opini 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 @@ -38,9 +53,11 @@ Take a look at the Changelog if you want a full list of recent changes, everythi ## 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/) @@ -52,12 +69,15 @@ If your platform is not supported, or you just want to be able to edit the sourc - [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` @@ -66,5 +86,6 @@ If you ever encounter compilation issues during the updating of Akkoma, you can - `rm -r _build` ## Documentation + - https://docs.akkoma.dev/stable - https://docs.akkoma.dev/develop