diff options
| author | kamtschatka <sschatka@gmail.com> | 2024-05-10 22:00:23 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-10 21:00:23 +0100 |
| commit | 1e317d97a39e170cd2eca53a2b1df2cee489f681 (patch) | |
| tree | 2e111d2ef109e0cc78abca6974c287bf8bb26a14 /docs | |
| parent | edf5fdbec67278e81c3538a553d567ff0a37d798 (diff) | |
| download | karakeep-1e317d97a39e170cd2eca53a2b1df2cee489f681.tar.zst | |
Development Instructions are incomplete/not working (fixes #145) (#146)
updated the documentation on how to set up the development environment
Co-authored-by: kamtschatka <simon.schatka@gmx.at>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/07-Development/01-setup.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/docs/07-Development/01-setup.md b/docs/docs/07-Development/01-setup.md index 775a5806..94a2ce67 100644 --- a/docs/docs/07-Development/01-setup.md +++ b/docs/docs/07-Development/01-setup.md @@ -4,13 +4,15 @@ ### First Setup - You'll need to prepare the environment variables for the dev env. -- Easiest would be to set it up once in the root of the repo and then symlink it in each app directory. +- Easiest would be to set it up once in the root of the repo and then symlink it in each app directory (e.g. `/apps/web`, `/apps/workers`) and also `/packages/db`. - Start by copying the template by `cp .env.sample .env`. - The most important env variables to set are: - `DATA_DIR`: Where the database and assets will be stored. This is the only required env variable. You can use an absolute path so that all apps point to the same dir. + - `NEXTAUTH_SECRET`: Random string used to sign the JWT tokens. Generate one with `openssl rand -base64 36`. Logging in will not work if this is missing! - `REDIS_HOST` and `REDIS_PORT` default to `localhost` and `6379` change them if redis is running on a different address. - `MEILI_ADDR`: If not set, search will be disabled. You can set it to `http://127.0.0.1:7700` if you run meilisearch using the command below. - `OPENAI_API_KEY`: If you want to enable auto tag inference in the dev env. +- run `pnpm run db:migrate` in the root of the repo to set up the database. ### Dependencies |