Update README

This commit is contained in:
itepechi 2023-08-04 06:28:11 +09:00
parent 557fce16e5
commit e3d8a83a1d

View file

@ -1,13 +1,14 @@
## What is This? ## What is this?
This is a fork of [AkkomaGang/akkoma](https://akkoma.dev/AkkomaGang/akkoma/), with an opinionated Docker setup. This is a fork of [AkkomaGang/akkoma](https://akkoma.dev/AkkomaGang/akkoma/), with some opinionated changes to satisfy my needs.
The differences between the upstream repository are described below: The main differences between this and the upstream repository are
- Uses the official Elixir image from Docker Hub - 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 - 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 - 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 that works the way Docker entry points are supposed to work - Has an actual Docker entry point, rather than a command that pretends to be an entry point
- Has out-of-the-box support for PGroonga, the fast and accurate full-text search extension for PostgreSQL
- Supports Podman quite well - Supports Podman quite well
## How to Setup (Podman Rootless) ## How to Setup (Podman Rootless)
@ -21,7 +22,7 @@ The differences between the upstream repository are described below:
### 1. Build your image ### 1. Build your image
This will take 10+ minutes. This will take 5+ minutes.
```sh ```sh
cd /YOUR/GIT/DIRECTORY/akkoma/ cd /YOUR/GIT/DIRECTORY/akkoma/