diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/01-intro.md | 2 | ||||
| -rw-r--r-- | docs/docs/02-installation.md | 14 | ||||
| -rw-r--r-- | docs/docs/03-configuration.md | 23 |
3 files changed, 24 insertions, 15 deletions
diff --git a/docs/docs/01-intro.md b/docs/docs/01-intro.md index 94851a61..6840466c 100644 --- a/docs/docs/01-intro.md +++ b/docs/docs/01-intro.md @@ -20,7 +20,7 @@ Hoarder is an open source "Bookmark Everything" app that uses AI for automatical - 📱 An iOS app that's pending apple's review (currently [beta testing](https://testflight.apple.com/join/QifpNxAT)), and the Android app is [almost ready](https://github.com/MohamedBassem/hoarder-app/issues/6). - 🌙 Dark mode support. - 💾 Self-hosting first. -- [Planned] Archiving the content for offline reading. +- [Planned] Downloading the content for offline reading. **⚠️ This app is under heavy development and it's far from stable.** diff --git a/docs/docs/02-installation.md b/docs/docs/02-installation.md index 94d44f5d..7e10b7b6 100644 --- a/docs/docs/02-installation.md +++ b/docs/docs/02-installation.md @@ -24,12 +24,13 @@ wget https://raw.githubusercontent.com/MohamedBassem/hoarder-app/main/docker/doc To configure the app, create a `.env` file in the directory and add this minimal env file: ``` -NEXTAUTH_SECRET=super_random_string HOARDER_VERSION=release +NEXTAUTH_SECRET=super_random_string MEILI_MASTER_KEY=another_random_string +NEXTAUTH_URL=http://localhost:3000 ``` -You **should** change the random strings. You can use `openssl rand -base64 36` to generate the random strings. +You **should** change the random strings. You can use `openssl rand -base64 36` to generate the random strings. You should also change the `NEXTAUTH_URL` variable to point to your server address. Using `HOARDER_VERSION=release` will pull the latest stable version. You might want to pin the version instead to control the upgrades (e.g. `HOARDER_VERSION=0.10.0`). Check the latest versions [here](https://github.com/MohamedBassem/hoarder-app/pkgs/container/hoarder-web). @@ -44,7 +45,11 @@ If you want more config params, check the config documentation [here](/configura To enable automatic tagging, you'll need to configure OpenAI. This is optional though but hightly recommended. - Follow [OpenAI's help](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key) to get an API key. -- Add `OPENAI_API_KEY=<key>` to the env file. +- Add the OpenAI API key to the env file: + +``` +OPENAI_API_KEY=<key> +``` Learn more about the costs of using openai [here](/openai). @@ -72,6 +77,9 @@ docker compose up -d Then visit `http://localhost:3000` and you should be greated with the Sign In page. +### [Optional] 6. Setup quick sharing extensions + +Go to the [quick sharing page](/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster! ## Updating diff --git a/docs/docs/03-configuration.md b/docs/docs/03-configuration.md index db660980..1cb1da76 100644 --- a/docs/docs/03-configuration.md +++ b/docs/docs/03-configuration.md @@ -2,17 +2,18 @@ The app is mainly configured by environment variables. All the used environment variables are listed in [packages/shared/config.ts](https://github.com/MohamedBassem/hoarder-app/blob/main/packages/shared/config.ts). The most important ones are: -| Name | Required | Default | Description | -| ----------------- | ------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| DATA_DIR | Yes | Not set | The path for the persistent data directory. This is where the db and the uploaded assets live. | -| NEXTAUTH_SECRET | Yes | Not set | Random string used to sign the JWT tokens. Generate one with `openssl rand -base64 36`. | -| REDIS_HOST | Yes | localhost | The address of redis used by background jobs | -| REDIS_PORT | Yes | 6379 | The port of redis used by background jobs | -| REDIS_DB_IDX | No | Not set | The db idx to use with redis. It defaults to 0 (in the client) so you don't usually need to set it unless you explicitly want another db. | -| MEILI_ADDR | No | Not set | The address of meilisearch. If not set, Search will be disabled. E.g. (`http://meilisearch:7700`) | -| MEILI_MASTER_KEY | Only in Prod and if search is enabled | Not set | The master key configured for meilisearch. Not needed in development environment. Generate one with `openssl rand -base64 36` | -| DISABLE_SIGNUPS | No | false | If enabled, no new signups will be allowed and the signup button will be disabled in the UI | -| MAX_ASSET_SIZE_MB | No | 4 | Sets the maximum allowed asset size (in MB) to be uploaded | +| Name | Required | Default | Description | +| ----------------- | ------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| DATA_DIR | Yes | Not set | The path for the persistent data directory. This is where the db and the uploaded assets live. | +| NEXTAUTH_URL | Yes | Not set | Should point to the address of your server. The app will function without it, but will redirect you to wrong addresses on signout for example. | +| NEXTAUTH_SECRET | Yes | Not set | Random string used to sign the JWT tokens. Generate one with `openssl rand -base64 36`. | +| REDIS_HOST | Yes | localhost | The address of redis used by background jobs | +| REDIS_PORT | Yes | 6379 | The port of redis used by background jobs | +| REDIS_DB_IDX | No | Not set | The db idx to use with redis. It defaults to 0 (in the client) so you don't usually need to set it unless you explicitly want another db. | +| MEILI_ADDR | No | Not set | The address of meilisearch. If not set, Search will be disabled. E.g. (`http://meilisearch:7700`) | +| MEILI_MASTER_KEY | Only in Prod and if search is enabled | Not set | The master key configured for meilisearch. Not needed in development environment. Generate one with `openssl rand -base64 36` | +| DISABLE_SIGNUPS | No | false | If enabled, no new signups will be allowed and the signup button will be disabled in the UI | +| MAX_ASSET_SIZE_MB | No | 4 | Sets the maximum allowed asset size (in MB) to be uploaded | ## Inference Configs (For automatic tagging) |