diff --git a/.env.example b/.env.example index b2dfb0805..559684160 100644 --- a/.env.example +++ b/.env.example @@ -93,6 +93,8 @@ NEXT_PRIVATE_SMTP_UNSAFE_IGNORE_TLS= NEXT_PRIVATE_SMTP_FROM_NAME="Documenso" # REQUIRED: Defines the email address to use as the from address. NEXT_PRIVATE_SMTP_FROM_ADDRESS="noreply@documenso.com" +# OPTIONAL: Defines the service for nodemailer +NEXT_PRIVATE_SMTP_SERVICE= # OPTIONAL: The API key to use for Resend.com NEXT_PRIVATE_RESEND_API_KEY= # OPTIONAL: The API key to use for MailChannels. diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index f69ddb57b..5515b37a6 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -89,22 +89,35 @@ jobs: APP_VERSION="$(git name-rev --tags --name-only $(git rev-parse HEAD) | head -n 1 | sed 's/\^0//')" GIT_SHA="$(git rev-parse HEAD)" - docker manifest create \ - documenso/documenso:latest \ - --amend documenso/documenso-amd64:latest \ - --amend documenso/documenso-arm64:latest \ + # Check if the version is stable (no rc or beta in the version) + if [[ "$APP_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then + docker manifest create \ + documenso/documenso:latest \ + --amend documenso/documenso-amd64:latest \ + --amend documenso/documenso-arm64:latest + + docker manifest push documenso/documenso:latest + fi + + if [[ "$APP_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+-rc\.[0-9]+$ ]]; then + docker manifest create \ + documenso/documenso:rc \ + --amend documenso/documenso-amd64:rc \ + --amend documenso/documenso-arm64:rc + + docker manifest push documenso/documenso:rc + fi docker manifest create \ documenso/documenso:$GIT_SHA \ --amend documenso/documenso-amd64:$GIT_SHA \ - --amend documenso/documenso-arm64:$GIT_SHA \ + --amend documenso/documenso-arm64:$GIT_SHA docker manifest create \ documenso/documenso:$APP_VERSION \ --amend documenso/documenso-amd64:$APP_VERSION \ - --amend documenso/documenso-arm64:$APP_VERSION \ + --amend documenso/documenso-arm64:$APP_VERSION - docker manifest push documenso/documenso:latest docker manifest push documenso/documenso:$GIT_SHA docker manifest push documenso/documenso:$APP_VERSION @@ -113,21 +126,34 @@ jobs: APP_VERSION="$(git name-rev --tags --name-only $(git rev-parse HEAD) | head -n 1 | sed 's/\^0//')" GIT_SHA="$(git rev-parse HEAD)" - docker manifest create \ - ghcr.io/documenso/documenso:latest \ - --amend ghcr.io/documenso/documenso-amd64:latest \ - --amend ghcr.io/documenso/documenso-arm64:latest \ + # Check if the version is stable (no rc or beta in the version) + if [[ "$APP_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then + docker manifest create \ + ghcr.io/documenso/documenso:latest \ + --amend ghcr.io/documenso/documenso-amd64:latest \ + --amend ghcr.io/documenso/documenso-arm64:latest + + docker manifest push ghcr.io/documenso/documenso:latest + fi + + if [[ "$APP_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+-rc\.[0-9]+$ ]]; then + docker manifest create \ + ghcr.io/documenso/documenso:rc \ + --amend ghcr.io/documenso/documenso-amd64:rc \ + --amend ghcr.io/documenso/documenso-arm64:rc + + docker manifest push ghcr.io/documenso/documenso:rc + fi docker manifest create \ ghcr.io/documenso/documenso:$GIT_SHA \ --amend ghcr.io/documenso/documenso-amd64:$GIT_SHA \ - --amend ghcr.io/documenso/documenso-arm64:$GIT_SHA \ + --amend ghcr.io/documenso/documenso-arm64:$GIT_SHA docker manifest create \ ghcr.io/documenso/documenso:$APP_VERSION \ --amend ghcr.io/documenso/documenso-amd64:$APP_VERSION \ - --amend ghcr.io/documenso/documenso-arm64:$APP_VERSION \ + --amend ghcr.io/documenso/documenso-arm64:$APP_VERSION - docker manifest push ghcr.io/documenso/documenso:latest docker manifest push ghcr.io/documenso/documenso:$GIT_SHA docker manifest push ghcr.io/documenso/documenso:$APP_VERSION diff --git a/.github/workflows/translations-upload.yml b/.github/workflows/translations-upload.yml index 65fd276f6..cb69d6338 100644 --- a/.github/workflows/translations-upload.yml +++ b/.github/workflows/translations-upload.yml @@ -21,7 +21,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 with: - ref: ${{ github.event.pull_request.head.ref }} + token: ${{ secrets.GH_PAT }} - uses: ./.github/actions/node-install diff --git a/apps/documentation/pages/developers/local-development/signing-certificate.mdx b/apps/documentation/pages/developers/local-development/signing-certificate.mdx index c06fe9440..b8c5b4812 100644 --- a/apps/documentation/pages/developers/local-development/signing-certificate.mdx +++ b/apps/documentation/pages/developers/local-development/signing-certificate.mdx @@ -11,6 +11,10 @@ Digitally signing documents requires a signing certificate in `.p12` format. You Follow the steps below to create a free, self-signed certificate for local development. + + These steps should be run on a UNIX based system, otherwise you may run into an error. + + ### Generate Private Key @@ -38,11 +42,17 @@ You will be prompted to enter some information, such as the certificate's Common Combine the private key and the self-signed certificate to create a `.p12` certificate. Use the following command: ```bash -openssl pkcs12 -export -out certificate.p12 -inkey private.key -in certificate.crt +openssl pkcs12 -export -out certificate.p12 -inkey private.key -in certificate.crt -legacy ``` - If you get the error "Error: Failed to get private key bags", add the `-legacy` flag to the command `openssl pkcs12 -export -out certificate.p12 -inkey private.key -in certificate.crt -legacy`. +When running the application in Docker, you may encounter permission issues when attempting to sign documents using your certificate (.p12) file. This happens because the application runs as a non-root user inside the container and needs read access to the certificate. + +To resolve this, you'll need to update the certificate file permissions to allow the container user 1001, which runs NextJS, to read it: + +```bash +sudo chown 1001 certificate.p12 +``` @@ -54,8 +64,8 @@ Note that for local development, the password can be left empty. ### Add Certificate to the Project -Finally, add the certificate to the project. Place the `certificate.p12` file in the `/apps/web/resources` directory. If the directory doesn't exist, create it. +Use the `NEXT_PRIVATE_SIGNING_LOCAL_FILE_PATH` environment variable to point at the certificate you created. -The final file path should be `/apps/web/resources/certificate.p12`. +Details about environment variables associated with certificates can be found [here](/developers/self-hosting/signing-certificate#configure-documenso-to-use-the-certificate). diff --git a/apps/documentation/pages/developers/self-hosting/how-to.mdx b/apps/documentation/pages/developers/self-hosting/how-to.mdx index a316b02b1..0d1583859 100644 --- a/apps/documentation/pages/developers/self-hosting/how-to.mdx +++ b/apps/documentation/pages/developers/self-hosting/how-to.mdx @@ -133,7 +133,7 @@ volumes: After updating the volume binding, save the `compose.yml` file and run the following command to start the containers: ```bash -docker-compose --env-file ./.env -d up +docker-compose --env-file ./.env up -d ``` The command will start the PostgreSQL database and the Documenso application containers. diff --git a/apps/documentation/pages/users/_meta.json b/apps/documentation/pages/users/_meta.json index 0d25e4a84..53733ea63 100644 --- a/apps/documentation/pages/users/_meta.json +++ b/apps/documentation/pages/users/_meta.json @@ -11,6 +11,7 @@ "templates": "Templates", "direct-links": "Direct Signing Links", "document-visibility": "Document Visibility", + "teams": "Teams", "-- Legal Overview": { "type": "separator", "title": "Legal Overview" diff --git a/apps/documentation/pages/users/document-visibility.mdx b/apps/documentation/pages/users/document-visibility.mdx deleted file mode 100644 index 8120f80bc..000000000 --- a/apps/documentation/pages/users/document-visibility.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Document Visibility -description: Learn how to control the visibility of your team documents. ---- - -# Team's Document Visibility - -By default, all documents created in a team are visible to all team members. However, you can control the visibility of your documents by changing the document's visibility settings. - -To set the visibility of a document, click on the **Document visibility** dropdown in the document's settings panel. - -![A screenshot of the Documenso's document editor page where you can update the document visibility](/document-visibility-settings.webp) - -The document visibility can be set to one of the following options: - -- **Everyone** - The document is visible to all team members. -- **Managers and above** - The document is visible to people with the role of Manager or above. -- **Admin only** - The document is only visible to the team's admins. diff --git a/apps/documentation/pages/users/teams/_meta.json b/apps/documentation/pages/users/teams/_meta.json new file mode 100644 index 000000000..b9548a39b --- /dev/null +++ b/apps/documentation/pages/users/teams/_meta.json @@ -0,0 +1,5 @@ +{ + "general-settings": "General Settings", + "document-visibility": "Document Visibility", + "sender-details": "Email Sender Details" +} diff --git a/apps/documentation/pages/users/teams/document-visibility.mdx b/apps/documentation/pages/users/teams/document-visibility.mdx new file mode 100644 index 000000000..8d2f82266 --- /dev/null +++ b/apps/documentation/pages/users/teams/document-visibility.mdx @@ -0,0 +1,45 @@ +--- +title: Document Visibility +description: Learn how to control the visibility of your team documents. +--- + +import { Callout } from 'nextra/components'; + +# Team's Document Visibility + +The default document visibility option allows you to control who can view and access the documents uploaded to your team account. The document visibility can be set to one of the following options: + +- **Everyone** - The document is visible to all team members. +- **Managers and above** - The document is visible to team members with the role of _Manager or above_ and _Admin_. +- **Admin only** - The document is only visible to the team's admins. + +![A screenshot of the document visibility selector from the team's general settings page](/teams/team-general-settings-document-visibility-select.webp) + +The default document visibility is set to "_EVERYONE_" by default. You can change this setting by going to the [team's general settings page](/users/teams/general-settings) and selecting a different visibility option. + + + If the team member uploading the document has a role lower than the default document visibility, + the document visibility will be set to a lower visibility level matching the team member's role. + + +Here's how it works: + +- If a user with the "_Member_" role creates a document and the default document visibility is set to "_Admin_" or "_Managers and above_", the document's visibility is set to "_Everyone_". +- If a user with the "_Manager_" role creates a document and the default document visibility is set to "_Admin_", the document's visibility is set to "_Managers and above_". +- Otherwise, the document's visibility is set to the default document visibility. + +You can change the visibility of a document at any time by editing the document and selecting a different visibility option. + +![A screenshot of the Documenso's document editor page where you can update the document visibility](/teams/document-visibility-settings.webp) + + + Updating the default document visibility in the team's general settings will not affect the + visibility of existing documents. You will need to update the visibility of each document + individually. + + +## A Note on Document Access + +The `document owner` (the user who created the document) always has access to the document, regardless of the document's visibility settings. This means that even if a document is set to "Admins only", the document owner can still view and edit the document. + +The `recipient` (the user who receives the document for signature, approval, etc.) also has access to the document, regardless of the document's visibility settings. This means that even if a document is set to "Admins only", the recipient can still view and sign the document. diff --git a/apps/documentation/pages/users/teams/general-settings.mdx b/apps/documentation/pages/users/teams/general-settings.mdx new file mode 100644 index 000000000..e10d379b0 --- /dev/null +++ b/apps/documentation/pages/users/teams/general-settings.mdx @@ -0,0 +1,15 @@ +--- +title: General Settings +description: Learn how to manage your team's General settings. +--- + +# General Settings + +You can manage your team's general settings by clicking on the **General Settings** tab in the team's settings dashboard. + +![A screenshot of team's General settings page](/teams/team-general-settings.webp) + +The general settings page allows you to update the following settings: + +- **Document Visibility** - Set the default visibility of the documents created by team members. Learn more about [document visibility](/users/teams/document-visibility). +- **Sender Details** - Set whether the sender's name should be included in the emails sent by the team. Learn more about [sender details](/users/teams/sender-details). diff --git a/apps/documentation/pages/users/teams/sender-details.mdx b/apps/documentation/pages/users/teams/sender-details.mdx new file mode 100644 index 000000000..196cd22e7 --- /dev/null +++ b/apps/documentation/pages/users/teams/sender-details.mdx @@ -0,0 +1,14 @@ +--- +title: Email Sender Details +description: Learn how to update the sender details for your team's email notifications. +--- + +## Sender Details + +If the **Sender Details** setting is enabled, the emails sent by the team will include the sender's name. The email will say: + +> "Example User" on behalf of "Example Team" has invited you to sign "document.pdf" + +If the **Sender Details** setting is disabled, the emails sent by the team will not include the sender's name. The email will say: + +> "Example Team" has invited you to sign "document.pdf" diff --git a/apps/documentation/public/document-visibility-settings.webp b/apps/documentation/public/teams/document-visibility-settings.webp similarity index 100% rename from apps/documentation/public/document-visibility-settings.webp rename to apps/documentation/public/teams/document-visibility-settings.webp diff --git a/apps/documentation/public/teams/team-general-settings-document-visibility-select.webp b/apps/documentation/public/teams/team-general-settings-document-visibility-select.webp new file mode 100644 index 000000000..ef312eeeb Binary files /dev/null and b/apps/documentation/public/teams/team-general-settings-document-visibility-select.webp differ diff --git a/apps/documentation/public/teams/team-general-settings.webp b/apps/documentation/public/teams/team-general-settings.webp new file mode 100644 index 000000000..3b5607e6a Binary files /dev/null and b/apps/documentation/public/teams/team-general-settings.webp differ diff --git a/apps/marketing/content/blog/project-babel.mdx b/apps/marketing/content/blog/project-babel.mdx new file mode 100644 index 000000000..f63ad72df --- /dev/null +++ b/apps/marketing/content/blog/project-babel.mdx @@ -0,0 +1,64 @@ +--- +title: Project Babel +description: We are announcing Project Babel - an initiative to support all languages of the world on Documenso. +authorName: 'Timur Ercan' +authorImage: '/blog/blog-author-timur.jpeg' +authorRole: 'Co-Founder' +date: 2024-11-08 +tags: + - Languages + - Community + - Open Source +--- + +
+ + +
The tower of Babel to add some Gravitas to this project.
+
+ +> TLDR; We are opening up translations to the community. Read this to add a language: https://documen.so/babel-fish + +## Announcing Project Babel: Powering Documenso with Global Language Support + +At Documenso, we believe that open source is more than just a software philosophy—it’s a way to build solutions that are open to all. Now, we’re happy to take that mission further with Project Babel, a community-driven initiative designed to bring worldwide language support to the Documenso platform. This project aims to enable Documenso to support as many languages as possible. + +## Why Language Support Matters + +We already have customers from 36 different countries and are seeing traffic from even more. When it comes to critical tools like signature platforms, having a user interface in your native language can make all the difference. No matter who and where you are, your team deserves tools that are fully accessible and intuitive. That’s why we’re making it our goal to support every language, and we need your help to make it happen! We’re building Documenso as a truly global public commodity. + +## The Vision Behind Project Babel + +The goal of Project Babel is simple but bold: We want to out-ship and out-customize every other document signing tool worldwide. How? By leveraging the collective power of our global community. + +Unlike closed-source software, where localization means waiting for updates from the core team, Project Babel lets anyone contribute a new language, improve an existing translation, or customize the experience to meet local cultural nuances. This flexibility isn’t just a bonus—it’s the baseline for truly global products. + +Through Project Babel, you can help make Documenso the most inclusive e-signature tool. Whether by adding a language you speak or fine-tuning existing translations, you’re shaping a platform that works for everyone, everywhere. + +## How You Can Contribute + +We’ve created a simple GitHub-based contribution flow to get started. We’ll improve the flow and user experience as the project progresses. As always, your contributions are highly valued. + + Check out the contribution guide here: [https://documen.so/babel-fish](https://documen.so/babel-fish) + +## Open Source Makes It Possible + +Closed-source solutions can’t keep up with the speed or depth of customization that open source offers. While other companies might take months or years to localize their products, Documenso can adapt and grow in real-time, thanks to contributions from our community. Whether it’s a small regional dialect or a widely spoken language, Project Babel ensures that Documenso evolves to meet the needs of people everywhere. + +> More importantly, this initiative empowers users. It allows you to control your software experience, ensuring it reflects your culture, language, and unique needs. + +Project Babel is more than a localization effort—it’s the first step toward democratizing access to highly customized software for everyone, no matter where they are or what language they speak. We’re incredibly excited about this initiative, but it can only succeed with your participation. We invite you to join us in making Documenso the most linguistically inclusive platform out there. + +Ready to get started? Check out the full tutorial and become part of the Babel community today! Let’s build open signing for the world: https://documen.so/babel-fish + +If you have any questions or comments, reach out on [Twitter / X](https://twitter.com/eltimuro) (DMs open) or [Discord](https://documen.so/discord). + +Thinking about switching to a modern signing platform? Reach out anytime: [https://documen.so/sales](https://documen.so/sales) + +Best from Hamburg\ +Timur diff --git a/apps/marketing/content/changelog.mdx b/apps/marketing/content/changelog.mdx index 3ca892eff..ec128df6d 100644 --- a/apps/marketing/content/changelog.mdx +++ b/apps/marketing/content/changelog.mdx @@ -8,6 +8,59 @@ Check out what's new in the latest version and read our thoughts on it. For more --- +# Documenso v1.8.0: Team Preferences, Signature Rejection, and Document Distribution + +We're excited to announce the release of Documenso v1.8.0! This update brings powerful new features to enhance your document signing process. Here's what's new: + +## 🌟 Key New Features + +### 1. Team Preferences + +Introducing **Team Preferences**, allowing administrators to configure settings and preferences that apply to documents across the entire team. This feature ensures consistency and simplifies management by letting you set default options, permissions, and preferences that automatically apply to all team members. + +![Team Preferences](/changelog/v1_8_0/team-global-settings.jpeg) + +### 2. Signature Rejection + +Recipients now have the option to **reject signatures**. This feature enhances communication by allowing recipients to decline signing, providing feedback or requesting changes before the document is finalized. + +