[GH-ISSUE #589] Improve the README for self-hosting #159

Closed
opened 2026-02-26 18:45:38 +03:00 by kerem · 6 comments
Owner

Originally created by @olivierlambert on GitHub (Oct 23, 2023).
Original GitHub issue: https://github.com/documenso/documenso/issues/589

Originally assigned to: @olivierlambert on GitHub.

Improvement Description

Right now, there's no guide on how to deploy Documenso outside for dev purpose. I'm not counting Docker because some people might want to do the deployment the way they want. The goal of this improvement (that I can realize) is to update the README for a step-by-step instruction for install and updating an installation.

Rationale

Current pain points:

  • no guide on how to do a manual install from scratch (no docker, no black box)
  • must read what's in the Docker file to replicate it

Proposed Solution

  • I can contribute to update the README file providing the instruction I used
  • Also showing it works with a reverse proxy in front of it doing the SSL work

Alternatives (optional)

  • I could write a guide somewhere else, but why not contributing to the upstream directly?

Additional Context

None

Checklist

  • I have searched the existing issues and improvement suggestions to avoid duplication.
  • I have provided a clear description of the improvement being suggested.
  • I have explained the rationale behind this improvement.
  • I have included any relevant technical details or design suggestions.
  • I understand that this is a suggestion and that there is no guarantee of implementation.
Originally created by @olivierlambert on GitHub (Oct 23, 2023). Original GitHub issue: https://github.com/documenso/documenso/issues/589 Originally assigned to: @olivierlambert on GitHub. ## Improvement Description Right now, there's no guide on how to deploy Documenso outside for dev purpose. I'm not counting Docker because some people might want to do the deployment the way they want. The goal of this improvement (that I can realize) is to update the README for a step-by-step instruction for install and updating an installation. ## Rationale Current pain points: * no guide on how to do a manual install from scratch (no docker, no black box) * must read what's in the Docker file to replicate it ## Proposed Solution * I can contribute to update the README file providing the instruction I used * Also showing it works with a reverse proxy in front of it doing the SSL work ## Alternatives (optional) * I could write a guide somewhere else, but why not contributing to the upstream directly? ## Additional Context None ## Checklist - [x] I have searched the existing issues and improvement suggestions to avoid duplication. - [x] I have provided a clear description of the improvement being suggested. - [x] I have explained the rationale behind this improvement. - [x] I have included any relevant technical details or design suggestions. - [x] I understand that this is a suggestion and that there is no guarantee of implementation.
kerem 2026-02-26 18:45:38 +03:00
Author
Owner

@Mythie commented on GitHub (Oct 23, 2023):

Sounds great! I’d also consider writing a bash script as part of the guide that does most of the steps assuming the target environment is using apt for package management.

<!-- gh-comment-id:1775033295 --> @Mythie commented on GitHub (Oct 23, 2023): Sounds great! I’d also consider writing a bash script as part of the guide that does most of the steps assuming the target environment is using apt for package management.
Author
Owner

@olivierlambert commented on GitHub (Oct 23, 2023):

Thanks :) I will make it the most generic possible at first, so anyone could simply follow it (like we did in our own Xen Orchestra documentation for example). We can always improve/add some automation later. I'll write a PR as soon as I can 👍

<!-- gh-comment-id:1775058287 --> @olivierlambert commented on GitHub (Oct 23, 2023): Thanks :) I will make it the most generic possible at first, so anyone could simply follow it (like we did in our own Xen Orchestra documentation [for example](https://xen-orchestra.com/docs/installation.html#from-the-sources)). We can always improve/add some automation later. I'll write a PR as soon as I can :+1:
Author
Owner

@olivierlambert commented on GitHub (Oct 23, 2023):

@Mythie on which branch do you want me to create the PR against?

<!-- gh-comment-id:1775060546 --> @olivierlambert commented on GitHub (Oct 23, 2023): @Mythie on which branch do you want me to create the PR against?
Author
Owner

@adithyaakrishna commented on GitHub (Oct 23, 2023):

@olivierlambert AFAIK, it would be the feat/refresh branch 👀

<!-- gh-comment-id:1775161445 --> @adithyaakrishna commented on GitHub (Oct 23, 2023): @olivierlambert AFAIK, it would be the `feat/refresh` branch 👀
Author
Owner

@olivierlambert commented on GitHub (Oct 28, 2023):

Should I close the issue since the PR is merged?

<!-- gh-comment-id:1783739821 --> @olivierlambert commented on GitHub (Oct 28, 2023): Should I close the issue since the PR is merged?
Author
Owner

@Mythie commented on GitHub (Oct 30, 2023):

Yep sorry about that one!

<!-- gh-comment-id:1784528861 --> @Mythie commented on GitHub (Oct 30, 2023): Yep sorry about that one!
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#159
No description provided.