Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(docs): enable new features documentations (#971)

Corentin Thomassetce1e891ec175
diff --git a/apps/docs/src/content/docs/03-guides/09-storage-key-patterns.mdx b/apps/docs/src/content/docs/03-guides/09-storage-key-patterns.mdx
index 2e5b61cd..c3f57f9c 100644
--- a/apps/docs/src/content/docs/03-guides/09-storage-key-patterns.mdx
+++ b/apps/docs/src/content/docs/03-guides/09-storage-key-patterns.mdx
@@ -6,7 +6,7 @@ slug: guides/storage-key-patterns
import { Aside } from '@astrojs/starlight/components';
<Aside type="note">
-**Not yet available:** Storage key patterns will be available in the next release.
+This feature is available starting from Papra v26.3.0
</Aside>
When a document is uploaded to Papra, the system generates a **storage key** that determines where and how the file is stored in the underlying storage backend (filesystem, S3, Azure Blob Storage, etc.). By default, Papra uses a legacy system that generates opaque storage keys based on the document ID. With storage key patterns, you can define a human-readable, customizable naming scheme for your stored files.
diff --git a/apps/docs/src/content/docs/03-guides/10-migrate-document-storage.mdx b/apps/docs/src/content/docs/03-guides/10-migrate-document-storage.mdx
index eb9f280a..0edbabd9 100644
--- a/apps/docs/src/content/docs/03-guides/10-migrate-document-storage.mdx
+++ b/apps/docs/src/content/docs/03-guides/10-migrate-document-storage.mdx
@@ -8,7 +8,7 @@ import { Aside } from '@astrojs/starlight/components';
import { Tabs, TabItem } from '@astrojs/starlight/components';
<Aside type="note">
-**Not yet available:** This migration script will be available in the next release.
+This migration script is available starting from Papra v26.3.0
</Aside>
The storage migration script copies every document from one storage backend to another, streaming files one at a time to keep memory usage flat. Encryption is handled transparently — documents are decrypted on the way out of the source and re-encrypted (or left plain) on the way into the destination, depending on each side's configuration.
diff --git a/apps/docs/src/content/navigation.ts b/apps/docs/src/content/navigation.ts
index de5fb7af..859d81c3 100644
--- a/apps/docs/src/content/navigation.ts
+++ b/apps/docs/src/content/navigation.ts
@@ -41,11 +41,10 @@ export const sidebar = [
label: 'Document Encryption',
slug: 'guides/document-encryption',
},
- // TODO: uncomment when released
- // {
- // label: 'Migrate Document Storage',
- // slug: 'guides/migrate-document-storage',
- // },
+ {
+ label: 'Migrate Document Storage',
+ slug: 'guides/migrate-document-storage',
+ },
{
label: 'Tagging Rules',
slug: 'guides/tagging-rules',
@@ -58,11 +57,10 @@ export const sidebar = [
label: 'Advanced Search',
slug: 'guides/advanced-search',
},
- // TODO: uncomment when released
- // {
- // label: 'Storage Key Patterns',
- // slug: 'guides/storage-key-patterns',
- // },
+ {
+ label: 'Storage Key Patterns',
+ slug: 'guides/storage-key-patterns',
+ },
],
},
{
diff --git a/apps/papra-server/src/modules/documents/storage/patterns/storage-pattern.config.ts b/apps/papra-server/src/modules/documents/storage/patterns/storage-pattern.config.ts
index d40a6d24..62d6334f 100644
--- a/apps/papra-server/src/modules/documents/storage/patterns/storage-pattern.config.ts
+++ b/apps/papra-server/src/modules/documents/storage/patterns/storage-pattern.config.ts
@@ -9,21 +9,18 @@ export const storagePatternConfig = {
schema: booleanishSchema,
default: true,
env: 'DOCUMENT_STORAGE_USE_LEGACY_STORAGE_KEY_DEFINITION_SYSTEM',
- showInDocumentation: false, // TODO: enable when released
},
maxIncrementalSuffixAttempts: {
doc: 'How many incremental suffixes to try when a storage key is already taken (e.g. file_1.txt, file_2.txt, ...). Set to 0 to skip incremental suffixes entirely.',
schema: z.coerce.number().int().nonnegative(),
default: 9, // This allows for a total of 10 attempts (the initial key + 9 incremental suffixes)
env: 'DOCUMENT_STORAGE_PATTERN_MAX_INCREMENTAL_SUFFIX_ATTEMPTS',
- showInDocumentation: false, // TODO: enable when released
},
enableRandomSuffixFallback: {
doc: 'Whether to enable a fallback mechanism that adds a random alphanumeric 8-character suffix to the storage key if all incremental suffix attempts are exhausted.',
schema: booleanishSchema,
default: true,
env: 'DOCUMENT_STORAGE_PATTERN_ENABLE_RANDOM_SUFFIX_FALLBACK',
- showInDocumentation: false, // TODO: enable when released
},
storageKeyPattern: {
doc: 'The pattern to use for generating storage keys. This can include expressions enclosed in double curly braces (e.g. {{document.name}}) that will be evaluated at runtime.',
@@ -40,6 +37,5 @@ export const storagePatternConfig = {
}),
default: '{{organization.id}}/{{document.name}}',
env: 'DOCUMENT_STORAGE_KEY_PATTERN',
- showInDocumentation: false, // TODO: enable when released
},
} as const satisfies AppConfigDefinition;