diff options
| author | Kyle Wilson <wilson15701@gmail.com> | 2025-06-22 07:08:18 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-22 12:08:18 +0100 |
| commit | 91a9d3c1aee04d77b2a2d022821f4a7a38e315f3 (patch) | |
| tree | eae54e1e22b69e1b234665fcafd5ec5e00db697a /docs/versioned_docs | |
| parent | 04f93941ca4d10f09befb4d1b219899ecbe792b1 (diff) | |
| download | karakeep-91a9d3c1aee04d77b2a2d022821f4a7a38e315f3.tar.zst | |
docs: update meilisearch key generation instruction (#1651)
* add pipe for trimming invalid characters when generating meili master key
* fix table row for MEILI_MASTER_KEY in versioned_docs
Diffstat (limited to 'docs/versioned_docs')
12 files changed, 12 insertions, 12 deletions
diff --git a/docs/versioned_docs/version-v0.15.0/03-configuration.md b/docs/versioned_docs/version-v0.15.0/03-configuration.md index 277d182e..5093d26e 100644 --- a/docs/versioned_docs/version-v0.15.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.15.0/03-configuration.md @@ -12,7 +12,7 @@ The app is mainly configured by environment variables. All the used environment | 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. | | REDIS_PASSWORD | No | Not set | The password used for redis authentication. It's not required if your redis instance doesn't require AUTH. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | 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 | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.16.0/03-configuration.md b/docs/versioned_docs/version-v0.16.0/03-configuration.md index ad94ff9b..cc07ba2b 100644 --- a/docs/versioned_docs/version-v0.16.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.16.0/03-configuration.md @@ -8,7 +8,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | 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 | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.17.0/03-configuration.md b/docs/versioned_docs/version-v0.17.0/03-configuration.md index f026977e..62d3a175 100644 --- a/docs/versioned_docs/version-v0.17.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.17.0/03-configuration.md @@ -8,7 +8,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 4 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.18.0/03-configuration.md b/docs/versioned_docs/version-v0.18.0/03-configuration.md index 9abd6fb2..4a74504f 100644 --- a/docs/versioned_docs/version-v0.18.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.18.0/03-configuration.md @@ -8,7 +8,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 4 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.19.0/03-configuration.md b/docs/versioned_docs/version-v0.19.0/03-configuration.md index c8fb4cc2..6f3423b5 100644 --- a/docs/versioned_docs/version-v0.19.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.19.0/03-configuration.md @@ -8,7 +8,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 4 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.20.0/03-configuration.md b/docs/versioned_docs/version-v0.20.0/03-configuration.md index 47c3227f..8a598bac 100644 --- a/docs/versioned_docs/version-v0.20.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.20.0/03-configuration.md @@ -8,7 +8,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 4 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.21.0/03-configuration.md b/docs/versioned_docs/version-v0.21.0/03-configuration.md index 82438dbf..04d5d92a 100644 --- a/docs/versioned_docs/version-v0.21.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.21.0/03-configuration.md @@ -8,7 +8,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 4 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.22.0/03-configuration.md b/docs/versioned_docs/version-v0.22.0/03-configuration.md index 59496409..e5682e24 100644 --- a/docs/versioned_docs/version-v0.22.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.22.0/03-configuration.md @@ -8,7 +8,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 50 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.23.0/03-configuration.md b/docs/versioned_docs/version-v0.23.0/03-configuration.md index 6e11774e..a0c2db45 100644 --- a/docs/versioned_docs/version-v0.23.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.23.0/03-configuration.md @@ -8,7 +8,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 50 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.23.1/03-configuration.md b/docs/versioned_docs/version-v0.23.1/03-configuration.md index 51ee23a5..5224351a 100644 --- a/docs/versioned_docs/version-v0.23.1/03-configuration.md +++ b/docs/versioned_docs/version-v0.23.1/03-configuration.md @@ -9,7 +9,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 50 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.24.0/03-configuration.md b/docs/versioned_docs/version-v0.24.0/03-configuration.md index c6fa024e..5ad43c79 100644 --- a/docs/versioned_docs/version-v0.24.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.24.0/03-configuration.md @@ -9,7 +9,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 50 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | diff --git a/docs/versioned_docs/version-v0.25.0/03-configuration.md b/docs/versioned_docs/version-v0.25.0/03-configuration.md index ac8883d4..d4a94c98 100644 --- a/docs/versioned_docs/version-v0.25.0/03-configuration.md +++ b/docs/versioned_docs/version-v0.25.0/03-configuration.md @@ -9,7 +9,7 @@ The app is mainly configured by environment variables. All the used environment | 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`. | | 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` | +| 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 \| tr -dc 'A-Za-z0-9'` | | MAX_ASSET_SIZE_MB | No | 50 | Sets the maximum allowed asset size (in MB) to be uploaded | | DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. | |