diff --git a/README.md b/README.md index 95964691c..c416d635f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ 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). +Also keep in mind that B in BNAkkoma stands for 'bleeding-edge', **features can be added, changed or removed at any time!** + +If you are experiencing any strange quirks, make sure both your frontend and backend are up to date. + +If your software are up to date but the bug is still there, ping me on the fediverse at '@itepechi@fedi.itepechi.me'. + ## What is this? This is a fork of [AkkomaGang/akkoma](https://akkoma.dev/AkkomaGang/akkoma/), with some opinionated changes to satisfy my needs. @@ -17,6 +23,7 @@ The main differences between this and the upstream repository are - 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 +- Added OpenSearch protocol support - Improved PWA support, sort of - Supports Podman quite well @@ -281,6 +288,14 @@ podman exec -it akkoma-web \ index ``` +### 9. Troubleshooting + +#### PGroonga search not working as expected + +Please make sure that you've applied all migrations using `pleroma_ctl migrate --migrations-path priv/repo/optional_migrations/pgroonga`, then set the options using `pleroma_ctl database set_pgroonga_options`. + +Read more at ['Switch to PGroonga'](#switch-to-pgroonga) and ['Change PGroonga indexing options'](#change-pgroonga-indexing-options). + --- ## Akkoma