diff options
| author | MohamedBassem <me@mbassem.com> | 2024-02-20 17:37:07 +0000 |
|---|---|---|
| committer | MohamedBassem <me@mbassem.com> | 2024-02-20 17:37:07 +0000 |
| commit | b08902af8f4b593b4f1c434b2e991d0ae08ccff3 (patch) | |
| tree | 8bad57aed2d0dd769313d09e466e149df7887651 | |
| parent | c3a03aad2dab21ed0dfb90f49d5c350496ad22e3 (diff) | |
| download | karakeep-b08902af8f4b593b4f1c434b2e991d0ae08ccff3.tar.zst | |
readme: Add the configuration variables to the readme
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -20,6 +20,19 @@ Docker is the recommended way for deploying the app. A docker compose file is pr Run `docker compose up` then head to `http://localhost:3000` to access the app. +> NOTE: You'll need to set the env variable `OPENAI_API_KEY` without your own openai key for automatic tagging to work. Check the next section for config details. + +## Configuration + +The app is configured with env variables. + +| Name | Default | Description | +| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| OPENAI_API_KEY | Not set | The OpenAI key used for automatic tagging. If not set, automatic tagging won't be enabled. The app currently uses `gpt-3.5-turbo-0125` which is [extremely cheap](https://openai.com/pricing). You'll be able to bookmark 1000+ for less than $1. | +| DATABASE_FILE | 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 | + ## Stack - [NextJS](https://nextjs.org/) for the web app. Using app router. |