chore(release): update versions (#334)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

README.md

@@ -39,12 +39,9 @@ A live demo of the platform is available at [demo.papra.app](https://demo.papra.
 
 ## Project Status
 
-Papra is currently in **beta**. The core functionality is stable and usable, but you may encounter occasional bugs or limitations. The project is actively developed, with new features being added regularly.
+Papra is under active development, the core functionalities are stable and usable. With lots of features and improvements added regularly. 
 
-- ✅ Core document management features are stable
-- ✅ Self-hosting is fully supported
-- 🚧 Some advanced features are still in development
-- 📝 Feedback and bug reports are highly appreciated
+Feedback and bug reports are highly appreciated to help us improve the platform.
 
 ## Features
 
@@ -63,11 +60,17 @@ Papra is currently in **beta**. The core functionality is stable and usable, but
 - **Folder ingestion**: Automatically import documents from a folder.
 - **CLI**: Manage your documents from the command line.
 - **API, SDK and webhooks**: Build your own applications on top of Papra.
-- *In progress:* **i18n**: Support for multiple languages.
+- **i18n**: Support for multiple languages.
 - *Coming soon:* **Document sharing**: Share documents with others.
 - *Coming soon:* **Document requests**: Generate upload links for people to add documents.
 - *Coming maybe one day:* **Mobile app**: Access and upload documents on the go.
 - *Coming maybe one day:* **Desktop app**: Access and upload documents from your computer.
+- *Coming maybe one day:* **Browser extension**: Upload documents from your browser.
+- *Coming maybe one day:* **AI**: Use AI to help you manage or tag your documents.
+
+## Sponsors
+
+Papra is a free and open-source project, but it is not free to run and develop. If you want to support the project, you can become a sponsor on [GitHub Sponsors](https://github.com/sponsors/corentinth) or [Buy me a coffee](https://buymeacoffee.com/cthmsst). If you are a company, you can also contact me to discuss a sponsorship.
 
 ## Self-hosting
 

apps/docs/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @papra/docs
 
+## 0.5.0
+
+### Minor Changes
+
+- [#337](https://github.com/papra-hq/papra/pull/337) [`1c574b8`](https://github.com/papra-hq/papra/commit/1c574b8305eb7bde4f1b75ac38a610ca0120a613) Thanks [@CorentinTh](https://github.com/CorentinTh)! - Added troubleshooting page
+
+### Patch Changes
+
+- [#337](https://github.com/papra-hq/papra/pull/337) [`1c574b8`](https://github.com/papra-hq/papra/commit/1c574b8305eb7bde4f1b75ac38a610ca0120a613) Thanks [@CorentinTh](https://github.com/CorentinTh)! - Added `docker compose up` command in dc generator
+
+## 0.4.2
+
+### Patch Changes
+
+- [#322](https://github.com/papra-hq/papra/pull/322) [`f54b8e1`](https://github.com/papra-hq/papra/commit/f54b8e162acd6cfe92241aaa649847fc03ca5852) Thanks [@CorentinTh](https://github.com/CorentinTh)! - Auto computes urls from the provided port
+
 ## 0.4.1
 
 ### Patch Changes

apps/docs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@papra/docs",
   "type": "module",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "private": true,
   "packageManager": "pnpm@10.9.0",
   "description": "Papra documentation website",

apps/docs/src/content/docs/04-resources/01-troubleshooting.mdx

@@ -0,0 +1,28 @@
+---
+title: Troubleshooting
+description: Troubleshooting guide for Papra
+slug: resources/troubleshooting
+---
+
+You can find here some common issues and how to fix them. If you encounter an issue that is not listed here, please [open an issue](https://github.com/papra-hq/papra/issues/new/choose) or [join our Discord](https://papra.app/discord).
+
+## Failed to ensure that the database directory exists
+
+Upon starting the server or a script, you may encounter this error
+
+```
+Failed to ensure that the database directory exists, error while creating the directory
+Error: EACCES: permission denied, mkdir './app-data/db'
+
+```
+
+Before accessing the DB sqlite file, the server will try to ensure that the database directory exists, and if it doesn't, it try will create it. But in case of insufficient permissions, it will fail.
+
+To fix this, you can either:
+
+- Create the directory manually `mkdir -p <your-app-data-dir>/db`
+- Ensure that the directory is owned by the user running the container
+- Run the server as root (not recommended)
+
+
+

apps/docs/src/content/docs/index.mdx

@@ -55,7 +55,7 @@ In today's digital world, managing countless important documents efficiently and
 - **Folder ingestion**: Automatically import documents from a folder.
 - **API, SDK and webhooks**: Build your own applications on top of Papra.
 - **CLI**: Manage your documents from the command line.
-- *In progress:* **i18n**: Support for multiple languages.
+- **i18n**: Support for multiple languages.
 - *Coming soon:* **Document sharing**: Share documents with others.
 - *Coming soon:* **Document requests**: Generate upload links for people to add documents.
 

apps/docs/src/content/navigation.ts

@@ -40,6 +40,10 @@ export const sidebar: StarlightUserConfig['sidebar'] = [
   {
     label: 'Resources',
     items: [
+      {
+        label: 'Troubleshooting',
+        slug: 'resources/troubleshooting',
+      },
       {
         label: 'CLI Documentation',
         slug: 'resources/cli',

apps/docs/src/docker-compose-generator/dc-generator.astro

@@ -24,9 +24,9 @@ services:
 `.trim();
 
 const dcHtml = await codeToHtml(defaultDockerCompose, { theme: 'vitesse-black', lang: 'yaml' });
+const defaultCommand = `mkdir -p ./app-data/{db,documents} && docker compose up -d`;
 ---
 
-<p>This tool will help you generate a custom docker-compose.yml file for Papra, tailored to your needs. You can personalize the service name, the port, the auth secret, and the source image.</p>
 
 <h2 class="mt-8 mb-2">General settings</h2>
 
@@ -125,7 +125,7 @@ const dcHtml = await codeToHtml(defaultDockerCompose, { theme: 'vitesse-black',
   </div>
   <div class="flex items-center gap-2 mt-1">
     <label for="intake-email-owlrelay-webhook-url" class="min-w-32">Webhook URL</label>
-    <input id="intake-email-owlrelay-webhook-url" class="input-field" type="text" placeholder="https://your-instance.com/api/intake-emails/ingest" />
+    <input id="intake-email-owlrelay-webhook-url" class="input-field" type="text" placeholder="https://your-instance.com/api/intake-emails/ingest" value="https://localhost:1221/api/intake-emails/ingest" />
   </div>
 </div>
 
@@ -146,9 +146,12 @@ const dcHtml = await codeToHtml(defaultDockerCompose, { theme: 'vitesse-black',
 
 <div id="docker-compose-output" class="mt-12" set:html={dcHtml} />
 
+<pre id="command-output" class="bg-card p-4 rounded-md text-muted-foreground text-sm font-mono overflow-x-auto">{defaultCommand}</pre>
+
 <div class="flex items-center gap-2 mt-4">
   <button class="btn bg-muted mt-0" id="download-button">Download docker-compose.yml</button>
-  <button class="btn bg-muted mt-0" id="copy-button">Copy to clipboard</button>
+  <button class="btn bg-muted mt-0" id="copy-button">Copy docker compose to clipboard</button>
+  <button class="btn bg-muted mt-0" id="copy-command-button">Copy command</button>
 </div>
 
 
@@ -179,6 +182,13 @@ const owlrelayWebhookUrlInput = document.getElementById('intake-email-owlrelay-w
 const cfEmailDomainInput = document.getElementById('intake-email-cf-email-domain') as HTMLInputElement;
 const webhookSecretInput = document.getElementById('intake-email-webhook-secret') as HTMLInputElement;
 const refreshWebhookSecretButton = document.getElementById('refresh-webhook-secret');
+const commandOutput = document.getElementById('command-output');
+const copyCommandButton = document.getElementById('copy-command-button');
+
+// Track whether the app base URL has been customized by the user
+let isAppBaseUrlCustomized = false;
+// Track whether the webhook URL has been customized by the user
+let isWebhookUrlCustomized = false;
 
 function getRandomString() {
   const alphabet = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
@@ -189,6 +199,76 @@ function copyToClipboard(text: string) {
   navigator.clipboard.writeText(text);
 }
 
+function isDefaultAppBaseUrl(url: string, port: string): boolean {
+  return url === `http://localhost:${port}`;
+}
+
+function generateDefaultWebhookUrl(baseUrl: string): string {
+  // Remove trailing slash if present
+  const cleanBaseUrl = baseUrl.replace(/\/$/, '');
+  return `${cleanBaseUrl}/api/intake-emails/ingest`;
+}
+
+function isDefaultWebhookUrl(webhookUrl: string, baseUrl: string): boolean {
+  return webhookUrl === generateDefaultWebhookUrl(baseUrl);
+}
+
+function refreshIsWebhookUrlCustomized() {
+  const currentBaseUrl = appBaseUrlInput.value.trim();
+  const currentWebhookUrl = owlrelayWebhookUrlInput.value.trim();
+
+  if (isDefaultWebhookUrl(currentWebhookUrl, currentBaseUrl)) {
+    isWebhookUrlCustomized = false;
+  } else {
+    isWebhookUrlCustomized = true;
+  }
+}
+
+function refreshIsAppBaseUrlCustomized() {
+  const currentPort = portInput.value;
+  const currentUrl = appBaseUrlInput.value.trim();
+
+  if (isDefaultAppBaseUrl(currentUrl, currentPort)) {
+    isAppBaseUrlCustomized = false;
+  } else {
+    isAppBaseUrlCustomized = true;
+  }
+}
+
+function updateWebhookUrlFromBaseUrl() {
+  if (!isWebhookUrlCustomized) {
+    const baseUrl = appBaseUrlInput.value.trim();
+    if (baseUrl) {
+      owlrelayWebhookUrlInput.value = generateDefaultWebhookUrl(baseUrl);
+    }
+  }
+}
+
+function updateAppBaseUrlFromPort() {
+  if (!isAppBaseUrlCustomized) {
+    const port = portInput.value;
+    appBaseUrlInput.value = `http://localhost:${port}`;
+    // Also update webhook URL when app base URL changes
+    updateWebhookUrlFromBaseUrl();
+  }
+}
+
+function handlePortChange() {
+  updateAppBaseUrlFromPort();
+  updateDockerCompose();
+}
+
+function handleAppBaseUrlChange() {
+  refreshIsAppBaseUrlCustomized();
+  updateWebhookUrlFromBaseUrl();
+  updateDockerCompose();
+}
+
+function handleWebhookUrlChange() {
+  refreshIsWebhookUrlCustomized();
+  updateDockerCompose();
+}
+
 function getDockerComposeYml() {
   const serviceName = serviceNameInput.value;
   const isRootless = privilegedModeSelect.value === 'false';
@@ -247,14 +327,31 @@ function getDockerComposeYml() {
   return stringify(dc);
 }
 
+function getStartCommand() {
+  const volumePath = volumePathInput.value;
+  const volumePathNormalized = volumePath.replace(/\/$/, '');
+  const volumeWithSubdirs = `${volumePathNormalized}/{db,documents}`;
+
+  const mkdirCommand = `mkdir -p ${volumeWithSubdirs}`;
+
+  const dockerCommand = 'docker compose up -d';
+
+  return `${mkdirCommand} && ${dockerCommand}`;
+}
+
 async function updateDockerCompose() {
   const dockerCompose = getDockerComposeYml();
+  const command = getStartCommand();
 
   const html = await codeToHtml(dockerCompose, { theme: 'vitesse-black', lang: 'yaml' });
 
   if (dockerComposeOutput) {
     dockerComposeOutput.innerHTML = html;
   }
+
+  if (commandOutput) {
+    commandOutput.textContent = command;
+  }
 }
 
 function handleCopy() {
@@ -346,12 +443,28 @@ function handleRefreshWebhookSecret() {
   updateDockerCompose();
 }
 
+function handleCopyCommand() {
+  const command = getStartCommand();
+
+  copyToClipboard(command);
+
+  if (copyCommandButton) {
+    copyCommandButton.textContent = 'Copied!';
+  }
+
+  setTimeout(() => {
+    if (copyCommandButton) {
+      copyCommandButton.textContent = 'Copy command';
+    }
+  }, 1000);
+}
+
 // Add event listeners
-portInput.addEventListener('input', updateDockerCompose);
+portInput.addEventListener('input', handlePortChange);
 sourceSelect.addEventListener('change', updateDockerCompose);
 serviceNameInput.addEventListener('input', updateDockerCompose);
 authSecretInput.addEventListener('input', updateDockerCompose);
-appBaseUrlInput.addEventListener('input', updateDockerCompose);
+appBaseUrlInput.addEventListener('input', handleAppBaseUrlChange);
 refreshSecretButton?.addEventListener('click', handleRefreshSecret);
 copyButton?.addEventListener('click', handleCopy);
 downloadButton?.addEventListener('click', handleDownload);
@@ -362,10 +475,11 @@ ingestionPathInput.addEventListener('input', updateDockerCompose);
 intakeEmailEnabledSelect.addEventListener('change', handleIntakeEmailEnabledChange);
 intakeDriverSelect.addEventListener('change', handleIntakeDriverChange);
 owlrelayApiKeyInput.addEventListener('input', updateDockerCompose);
-owlrelayWebhookUrlInput.addEventListener('input', updateDockerCompose);
+owlrelayWebhookUrlInput.addEventListener('input', handleWebhookUrlChange);
 cfEmailDomainInput.addEventListener('input', updateDockerCompose);
 webhookSecretInput.addEventListener('input', updateDockerCompose);
 refreshWebhookSecretButton?.addEventListener('click', handleRefreshWebhookSecret);
+copyCommandButton?.addEventListener('click', handleCopyCommand);
 
 authSecretInput.value = getRandomString();
 

apps/docs/src/pages/docker-compose-generator.astro

@@ -8,8 +8,9 @@ import DockerComposeGeneratorComp from '../docker-compose-generator/dc-generator
         title: 'Papra docker-compose.yml generator',
         description: 'Generate a custom docker-compose.yml file for Papra, tailored to your needs.',
         tableOfContents: false,
-
     }}
 >
+    <p>This tool will help you generate a custom docker-compose.yml file for Papra, tailored to your needs. You can personalize the service name, the port, the auth secret, and the source image.</p>
+    <p>For more configuration options, you can use the <a href="/self-hosting/configuration">configuration reference</a>.</p>
     <DockerComposeGeneratorComp />
 </StarlightPage>

apps/papra-client/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @papra/app-client
 
+## 0.6.2
+
+### Patch Changes
+
+- [#333](https://github.com/papra-hq/papra/pull/333) [`ff830c2`](https://github.com/papra-hq/papra/commit/ff830c234a02ddb4cbc480cf77ef49b8de35fbae) Thanks [@CorentinTh](https://github.com/CorentinTh)! - Fixed version release link
+
+## 0.6.1
+
 ## 0.6.0
 
 ### Minor Changes

apps/papra-client/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@papra/app-client",
   "type": "module",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "private": true,
   "packageManager": "pnpm@10.9.0",
   "description": "Papra frontend client",

apps/papra-client/src/modules/config/config.ts

@@ -5,7 +5,7 @@ const asString = <T extends string | undefined>(value: string | undefined, defau
 const asNumber = <T extends number | undefined>(value: string | undefined, defaultValue?: T): T extends undefined ? number | undefined : number => (value === undefined ? defaultValue : Number(value)) as T extends undefined ? number | undefined : number;
 
 export const buildTimeConfig = {
-  papraVersion: asString(import.meta.env.VITE_PAPRA_VERSION),
+  papraVersion: asString(import.meta.env.VITE_PAPRA_VERSION, '0.0.0'),
   baseUrl: asString(import.meta.env.VITE_BASE_URL, window.location.origin),
   baseApiUrl: asString(import.meta.env.VITE_BASE_API_URL, window.location.origin),
   vitrineBaseUrl: asString(import.meta.env.VITE_VITRINE_BASE_URL, 'http://localhost:3000/'),

apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsx

@@ -36,6 +36,12 @@ const MenuItemButton: Component<MenuItem> = (props) => {
   );
 };
 
+function getReleaseUrl({ version, packageName = '@papra/app-server' }: { version: string; packageName?: string }) {
+  const encodedVersion = encodeURIComponent(`${packageName}@${version}`);
+
+  return `https://github.com/papra-hq/papra/releases/tag/${encodedVersion}`;
+}
+
 export const SideNav: Component<{
   mainMenu?: MenuItem[];
   footerMenu?: MenuItem[];
@@ -95,7 +101,7 @@ export const SideNav: Component<{
           ))}
         </div>
 
-        <a class="text-xs text-muted-foreground text-center mt-auto transition-colors hover:(text-primary underline)" href={`https://github.com/papra-hq/papra/releases/tag/${version}`} target="_blank" rel="noopener noreferrer">
+        <a class="text-xs text-muted-foreground text-center mt-auto transition-colors hover:(text-primary underline)" href={getReleaseUrl({ version: config.papraVersion })} target="_blank" rel="noopener noreferrer">
           {version}
         </a>
 

apps/papra-server/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @papra/app-server
 
+## 0.6.2
+
+### Patch Changes
+
+- [#337](https://github.com/papra-hq/papra/pull/337) [`1c574b8`](https://github.com/papra-hq/papra/commit/1c574b8305eb7bde4f1b75ac38a610ca0120a613) Thanks [@CorentinTh](https://github.com/CorentinTh)! - Ensure database directory exists when running scripts (like migrations)
+
+## 0.6.1
+
+### Patch Changes
+
+- [#326](https://github.com/papra-hq/papra/pull/326) [`17ca8f8`](https://github.com/papra-hq/papra/commit/17ca8f8f8110c3ffb550f67bfba817872370171c) Thanks [@CorentinTh](https://github.com/CorentinTh)! - Fix content disposition header to support non-ascii filenames
+
 ## 0.6.0
 
 ### Minor Changes

apps/papra-server/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@papra/app-server",
   "type": "module",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "private": true,
   "packageManager": "pnpm@10.9.0",
   "description": "Papra app server",

apps/papra-server/src/modules/app/database/database.services.ts

@@ -31,6 +31,6 @@ export async function ensureLocalDatabaseDirectoryExists({ config }: { config: C
       logger.info({ dbUrl: url, dbDir, dbPath }, 'Database directory missing, created it');
     }
   } catch (error) {
-    logger.error({ error, dbDir, dbPath }, 'Failed to ensure that the database directory exists, error while creating the directory');
+    logger.error({ error, dbDir, dbPath }, 'Failed to ensure that the database directory exists, error while creating the directory. Please see https://docs.papra.app/resources/troubleshooting/#failed-to-ensure-that-the-database-directory-exists for more information.');
   }
 }

apps/papra-server/src/modules/documents/documents.routes.ts

@@ -329,7 +329,7 @@ function setupGetDocumentFileRoute({ app, config, db }: RouteDefinitionContext)
         200,
         {
           'Content-Type': document.mimeType,
-          'Content-Disposition': `inline; filename="${document.name}"`,
+          'Content-Disposition': `inline; filename*=UTF-8''${encodeURIComponent(document.name)}`,
           'Content-Length': String(document.originalSize),
         },
       );

apps/papra-server/src/scripts/commons/run-script.ts

@@ -3,6 +3,7 @@ import type { Config } from '../../modules/config/config.types';
 import type { Logger } from '../../modules/shared/logger/logger';
 import process from 'node:process';
 import { setupDatabase } from '../../modules/app/database/database';
+import { ensureLocalDatabaseDirectoryExists } from '../../modules/app/database/database.services';
 import { parseConfig } from '../../modules/config/config';
 import { createLogger, wrapWithLoggerContext } from '../../modules/shared/logger/logger';
 
@@ -23,6 +24,7 @@ async function runScript(
       const logger = createLogger({ namespace: 'scripts' });
 
       const { config } = await parseConfig({ env: process.env });
+      await ensureLocalDatabaseDirectoryExists({ config });
       const { db, client } = setupDatabase({ ...config.database });
 
       try {