[PR #1251] [CLOSED] docs: clearer wording and corrections to Docker #1511

Closed
opened 2026-02-26 19:33:34 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/documenso/documenso/pull/1251
Author: @sigreer
Created: 7/24/2024
Status: Closed

Base: mainHead: main


📄 Description


name: docs: clearer wording and corrections to Docker documentation.
about: Proposed changes to make the Docker documentation clearer

Description

There were some env vars not detailed in the documentation as well as some confusing references. I included the process for generating keys which was mentioned but not linked to, and also provided more explicit instructions relating to the environment variables required; Following the documentation as it currently exists will return several errors due to some of the required fields not being included (nominally the Postgres DB details).

Generally speaking I've tried to make it so that users don't need to hop between different sets of documentation to complete a basic production setup.

I've also removed the section relating to launching a standalone instance as this is generally considered obsolete.

Summary by CodeRabbit

  • Documentation
    • Enhanced clarity and detail of Docker setup instructions for the Documenso application.
    • Specified default Docker Compose setup includes both Documenso app and PostgreSQL container.
    • Listed prerequisites, including the need for a valid SMTP account or API details.
    • Reformatted setup steps into a numbered list for better readability.
    • Expanded instructions for generating a p12 signing key with detailed commands.
    • Improved instructions for modifying the compose.yml file and environment variables.
    • Updated commands for running containers to a more user-friendly format.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/documenso/documenso/pull/1251 **Author:** [@sigreer](https://github.com/sigreer) **Created:** 7/24/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `main` --- ### 📄 Description --- name: docs: clearer wording and corrections to Docker documentation. about: Proposed changes to make the Docker documentation clearer --- ## Description There were some env vars not detailed in the documentation as well as some confusing references. I included the process for generating keys which was mentioned but not linked to, and also provided more explicit instructions relating to the environment variables required; Following the documentation as it currently exists will return several errors due to some of the required fields not being included (nominally the Postgres DB details). Generally speaking I've tried to make it so that users don't need to hop between different sets of documentation to complete a basic production setup. I've also removed the section relating to launching a standalone instance as this is generally considered obsolete. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Enhanced clarity and detail of Docker setup instructions for the Documenso application. - Specified default Docker Compose setup includes both Documenso app and PostgreSQL container. - Listed prerequisites, including the need for a valid SMTP account or API details. - Reformatted setup steps into a numbered list for better readability. - Expanded instructions for generating a p12 signing key with detailed commands. - Improved instructions for modifying the `compose.yml` file and environment variables. - Updated commands for running containers to a more user-friendly format. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-26 19:33:34 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/documenso#1511
No description provided.