aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMohamedBassem <me@mbassem.com>2024-03-01 21:01:00 +0000
committerMohamedBassem <me@mbassem.com>2024-03-01 22:11:49 +0000
commita5434730ede1272f195d6a4b13207b840a5ac2cf (patch)
tree14c8a22fbf573b36f16a434349fd3516b38ea539 /README.md
parent75d315dda4232ee3b89abf054f0b6ee10105ffe3 (diff)
downloadkarakeep-a5434730ede1272f195d6a4b13207b840a5ac2cf.tar.zst
feature: Add full text search support
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1bdfb960..9b17b074 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,8 @@ A self-hostable bookmark-everything app with a touch of AI for the data hoarders
- 🔖 Chrome plugin for quick bookmarking.
- 📱 iOS shortcut for bookmarking content from the phone. A minimal mobile app might come later.
- 💾 Self-hostable first.
+- 🔎 Full text search of all the content stored.
- [Planned] Archiving the content for offline reading.
-- [Planned] Full text search of all the content stored.
- [Planned] Store raw images.
**⚠️ This app is under heavy development and it's far from stable.**
@@ -37,6 +37,8 @@ The app is configured with env variables.
| DATABASE_URL | Not set | The path for the sqlite database. |
| REDIS_HOST | localhost | The address of redis used by background jobs |
| REDIS_POST | 6379 | The port of redis used by background jobs |
+| MEILI_ADDR | Not set | The address of meilisearch. If not set, Search will be disabled. |
+| MEILI_MASTER_KEY | Not set | The master key configured for meili. Not needed in development. |
## Security Considerations
@@ -62,6 +64,7 @@ To mitigate those risks, you can do one of the following:
- [Puppeteer](https://pptr.dev/) for crawling the bookmarks.
- [OpenAI](https://openai.com/) because AI is so hot right now.
- [BullMQ](https://bullmq.io) for scheduling the background jobs.
+- [Meilisearch](https://meilisearch.com) for the full content search.
## Why did I build it?