itepechi
/
akkoma
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Update README

This commit is contained in:
itepechi 2023-09-27 05:29:26 +09:00
parent 66e26882e8
commit d9aaf0ee78
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,8 +1,6 @@
# BNAkkoma – Brand New Akkoma # BNAkkoma: Brand New Akkoma
<small> <small>It's not that new. This is just a cheap pun on the title of a [furry anime](https://en.wikipedia.org/wiki/BNA:_Brand_New_Animal).</small>
*It's not that new. It's just a pun on a so-called anime.*
</small>
## What is this? ## What is this?
@ -15,8 +13,11 @@ The main differences between this and the upstream repository are
- 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, rather than a command that pretends to be an entry point - 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 - Includes out-of-the-box support for [PGroonga](https://pgroonga.github.io/), the fast and accurate full-text search extension for PostgreSQL
- Added support for searching media status, which I really needed - Added support for searching media posts, which I really needed
- Added support to search for posts from people you follow, which is nice to have
- These search extensions are configurable, so simply turn off if you don't want them
- Includes some improvements to the initial configuration wizard - Includes some improvements to the initial configuration wizard
- Improved PWA support, sort of
- Supports Podman quite well - Supports Podman quite well
## How to setup (Podman Rootless) ## How to setup (Podman Rootless)
@ -202,6 +203,7 @@ Keep in mind that all of these steps are optional.
Before proceeding, make sure that `config :pleroma, :database, pgroonga_enabled` is set to `false`. Before proceeding, make sure that `config :pleroma, :database, pgroonga_enabled` is set to `false`.
```ex ```ex
# Example configuration
config :pleroma, :database, config :pleroma, :database,
rum_enabled: false, rum_enabled: false,
pgroonga_enabled: false pgroonga_enabled: false
@ -219,9 +221,10 @@ podman exec -it akkoma-web \
After running the migration, change `config :pleroma, :database, pgroonga_enabled` to `true`. After running the migration, change `config :pleroma, :database, pgroonga_enabled` to `true`.
```ex ```ex
# Example configuration
config :pleroma, :database, config :pleroma, :database,
rum_enabled: false, rum_enabled: false,
pgroonga_enabled: true # set this option to true pgroonga_enabled: true
``` ```
Don't forget to restart your backend for the changes to take effect. Don't forget to restart your backend for the changes to take effect.