Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-19 11:12:06 +10:00
Code Issues Packages Projects Releases Wiki Activity

chore: update docs

Browse Source
This commit is contained in:
Ephraim Atta-Duncan
2025-08-22 05:19:00 +00:00
parent 1c193abe40
commit de553a4b36
4 changed files with 57 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.env.example
View File

@ -116,7 +116,11 @@ NEXT_PRIVATE_STRIPE_API_KEY=
NEXT_PRIVATE_STRIPE_WEBHOOK_SECRET= NEXT_PRIVATE_STRIPE_WEBHOOK_SECRET=
# [[BACKGROUND JOBS]] # [[BACKGROUND JOBS]]
# Job provider for background tasks. Options: "local" or "inngest"
# NOTE: Document reminders require scheduled jobs and only work with "inngest"
# The "local" provider only supports immediate job execution
NEXT_PRIVATE_JOBS_PROVIDER="local" NEXT_PRIVATE_JOBS_PROVIDER="local"
# Inngest event key for scheduled jobs (required when using "inngest" provider)
NEXT_PRIVATE_INNGEST_EVENT_KEY= NEXT_PRIVATE_INNGEST_EVENT_KEY=
# [[FEATURES]] # [[FEATURES]]

3
README.md
View File

@ -180,6 +180,9 @@ git clone https://github.com/<your-username>/documenso
- Optional: Seed the database using `npm run prisma:seed -w @documenso/prisma` to create a test user and document. - Optional: Seed the database using `npm run prisma:seed -w @documenso/prisma` to create a test user and document.
- Optional: Create your own signing certificate. - Optional: Create your own signing certificate.
- To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL), see **[Create your own signing certificate](./SIGNING.md)**. - To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL), see **[Create your own signing certificate](./SIGNING.md)**.
- Optional: Configure job provider for document reminders.
- The default local job provider does not support scheduled jobs required for document reminders.
- To enable reminders, set `NEXT_PRIVATE_JOBS_PROVIDER=inngest` and provide `NEXT_PRIVATE_INNGEST_EVENT_KEY` in your `.env` file.
### Run in Gitpod ### Run in Gitpod

4
apps/documentation/pages/developers/self-hosting/how-to.mdx
View File

@ -195,7 +195,7 @@ You can access the Documenso application by visiting the URL you provided for th
The environment variables listed above are a subset of those available for configuring Documenso. The table below provides a complete list of environment variables and their descriptions. The environment variables listed above are a subset of those available for configuring Documenso. The table below provides a complete list of environment variables and their descriptions.
| Variable | Description | | Variable | Description |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------- | | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `PORT` | The port on which the Documenso application runs. It defaults to `3000`. | | `PORT` | The port on which the Documenso application runs. It defaults to `3000`. |
| `NEXTAUTH_SECRET` | The secret key used by NextAuth.js for encryption and signing. | | `NEXTAUTH_SECRET` | The secret key used by NextAuth.js for encryption and signing. |
| `NEXT_PRIVATE_ENCRYPTION_KEY` | The primary encryption key for symmetric encryption and decryption (at least 32 characters). | | `NEXT_PRIVATE_ENCRYPTION_KEY` | The primary encryption key for symmetric encryption and decryption (at least 32 characters). |
@ -235,6 +235,8 @@ The environment variables listed above are a subset of those available for confi
| `NEXT_PUBLIC_DOCUMENT_SIZE_UPLOAD_LIMIT` | The maximum document upload limit displayed to the user (in MB). | | `NEXT_PUBLIC_DOCUMENT_SIZE_UPLOAD_LIMIT` | The maximum document upload limit displayed to the user (in MB). |
| `NEXT_PUBLIC_POSTHOG_KEY` | The optional PostHog key for analytics and feature flags. | | `NEXT_PUBLIC_POSTHOG_KEY` | The optional PostHog key for analytics and feature flags. |
| `NEXT_PUBLIC_DISABLE_SIGNUP` | Whether to disable user signups through the /signup page. | | `NEXT_PUBLIC_DISABLE_SIGNUP` | Whether to disable user signups through the /signup page. |
| `NEXT_PRIVATE_JOBS_PROVIDER` | The job provider to use. Available options: `local` (default) or `inngest`. Note: Document reminders require `inngest`. |
| `NEXT_PRIVATE_INNGEST_EVENT_KEY` | The Inngest event key for scheduled jobs. Required when using `inngest` as the job provider. |
## Run as a Service ## Run as a Service

8
packages/lib/jobs/client/client.ts
View File

@ -12,7 +12,13 @@ export class JobClient<T extends ReadonlyArray<JobDefinition> = []> {
public constructor(definitions: T) { public constructor(definitions: T) {
this._provider = match(env('NEXT_PRIVATE_JOBS_PROVIDER')) this._provider = match(env('NEXT_PRIVATE_JOBS_PROVIDER'))
.with('inngest', () => InngestJobProvider.getInstance()) .with('inngest', () => InngestJobProvider.getInstance())
.otherwise(() => LocalJobProvider.getInstance()); .otherwise(() => {
console.warn(
'⚠️ Local job provider detected. Document reminders will not work as they require scheduled jobs. ' +
'To enable reminders, configure Inngest by setting NEXT_PRIVATE_JOBS_PROVIDER=inngest and providing NEXT_PRIVATE_INNGEST_EVENT_KEY.',
);
return LocalJobProvider.getInstance();
});
definitions.forEach((definition) => { definitions.forEach((definition) => {
this._provider.defineJob(definition); this._provider.defineJob(definition);