161sh/iceshrimp-161sh
1
0
Fork 0
mirror of https://iceshrimp.dev/crimekillz/iceshrimp-161sh.git synced 2024-11-24 21:19:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: 📝 KeyDB, megalodon

Browse Source
This commit is contained in:
ThatOneCalculator 2023-07-06 17:29:29 -07:00
parent 655cc039f3
commit 6decfe88e7
2 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -106,8 +106,8 @@ If you have access to a server that supports one of the sources below, I recomme
- [ElasticSearch](https://www.elastic.co/elasticsearch/) - [ElasticSearch](https://www.elastic.co/elasticsearch/)
- Caching server - Caching server
- 🐲 At least [DragonflyDB](https://www.dragonflydb.io/) v1.4.0 (recommended) - 🐲 At least [DragonflyDB](https://www.dragonflydb.io/) v1.4.0 (recommended)
- 👻 At least [KeyDB](https://keydb.dev/) v6.3.3
- 🍱 Another [Redis](https://redis.io/) server, at least v6 - 🍱 Another [Redis](https://redis.io/) server, at least v6
- 👻 [KeyDB](https://keydb.dev/) (untested)
### 🏗️ Build dependencies ### 🏗️ Build dependencies
- 🦀 At least [Rust](https://www.rust-lang.org/) v1.68.0 - 🦀 At least [Rust](https://www.rust-lang.org/) v1.68.0
@ -166,9 +166,7 @@ In Calckey's directory, fill out the `db` section of `.config/default.yml` with
## 💰 Caching server ## 💰 Caching server
If you experience a lot of traffic, it's a good idea to set up another Redis-compatible caching server. If you don't set one one up, it'll fall back to the mandatory Redis server. If you experience a lot of traffic, it's a good idea to set up another Redis-compatible caching server. If you don't set one one up, it'll fall back to the mandatory Redis server. DragonflyDB is the recommended option due to its unrivaled performance and ease of use.
For DragonflyDB, launch with the flag `--default_lua_flags='allow-undeclared-keys'`.
## 🔎 Set up search ## 🔎 Set up search

1
packages/README.md
View File

@ -7,3 +7,4 @@ This directory contains all of the packages Calckey uses.
- `client`: Web interface written in Vue3 and TypeScript - `client`: Web interface written in Vue3 and TypeScript
- `sw`: Web [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) written in TypeScript - `sw`: Web [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) written in TypeScript
- `calckey-js`: TypeScript SDK for both backend and client, also published on [NPM](https://www.npmjs.com/package/calckey-js) for public use - `calckey-js`: TypeScript SDK for both backend and client, also published on [NPM](https://www.npmjs.com/package/calckey-js) for public use
- `megalodon`: TypeScript library used for partial Mastodon API compatibility