From 56ea99856cad5d6b3c63ea667551d09eab2348b6 Mon Sep 17 00:00:00 2001 From: Bohdan Shulha Date: Thu, 17 Oct 2024 18:15:18 +0200 Subject: [PATCH 1/2] docs: chatwoot installation via ptah.sh --- docs/self-hosted/deployment/ptah.sh.md | 40 ++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/self-hosted/deployment/ptah.sh.md diff --git a/docs/self-hosted/deployment/ptah.sh.md b/docs/self-hosted/deployment/ptah.sh.md new file mode 100644 index 00000000..e2029ed9 --- /dev/null +++ b/docs/self-hosted/deployment/ptah.sh.md @@ -0,0 +1,40 @@ +--- +sidebar_label: "Ptah.sh" +title: "Ptah.sh Production deployment guide" +help_discord: "https://r.ptah.sh/chat" +help_github_discussions: "https://github.com/chatwoot/chatwoot/discussions/categories/self-hosted" +--- + +## Ptah.sh Overview + +Ptah.sh is an easy-to-use Docker container management tool. It uses a Docker Swarm under the hood, so it is ready for any small and medium business workloads. The service has been made available as a [Chatwoot one-click app in Ptah.sh](https://ptah.sh/marketplace/customer-support/chatwoot/), and the deployment process is straightforward. + +**Note:** This is a community-contributed installation setup. This will only have community support for any issues in the future. + +## Setup Chatwoot Using Ptah.sh +### 1. Pick your Ptah.sh Panel Option + +Finish your Ptah.sh installation by referring to [Tutorial](https://ptah.sh/tutorial/vps/). You can choose either the self-hosted or cloud option of Ptah.sh - both work the same way. + +### 2. Install Chatwoot + +Chatwoot is available in the one-click apps option in Ptah.sh. + +Once you configure your VM, navigate to the "Services" page and create a new one. + +Click "Use Template" and pick Chatwoot. You'll have to enter the domain name where you want to run your Chatwoot installation (make sure the domain name points to your server) and the E-Mail credentials that will be used for communications. + +Redis, Postgresql, Backups, and HTTPS will be configured automagically. + +You can adjust any of the settings via environment variables or custom configs at any time (before or after service initialization). + +The installation process is fully automatic and takes a few minutes. + +### 3. Check the Installation + +Once the process is completed, please navigate to your Chatwoot installation, create a user and disable user registration by changing the `ENABLE_ACCOUNT_SIGNUP` environment variable to `false`. + +## Upgrading Chatwoot installation + +To update your Chatwoot installation to the latest version in Ptah.sh, you can just go to your service and change the versions of the corresponding docker images - Ptah.sh will take care of the rest. Check the [Chatwoot changelog](https://www.chatwoot.com/changelog/) to watch after the releases and possible breaking changes. + From fe401b8dd4ebefc1e9258eb38f6e20bb81cb678a Mon Sep 17 00:00:00 2001 From: Bohdan Shulha Date: Thu, 17 Oct 2024 18:23:44 +0200 Subject: [PATCH 2/2] docs: chatwoot installation via ptah.sh --- docs/self-hosted.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/self-hosted.md b/docs/self-hosted.md index 940d8556..ca9cb2b4 100644 --- a/docs/self-hosted.md +++ b/docs/self-hosted.md @@ -35,6 +35,7 @@ This guide will help you to install and setup a production ready Chatwoot. - [Restack](/docs/self-hosted/deployment/restack) - [Easypanel](/docs/self-hosted/deployment/easypanel) - [Elestio](/docs/self-hosted/deployment/elestio) +- [Ptah.sh](/docs/self-hosted/deployment/ptah.sh) ## Configuration