-d postgres
+```
+
+### Step 5: Restore the database
+
+Restore the database from the backup file.
+
+```bash
+pg_restore --verbose --clean --no-acl --no-owner --create -U postgres -d postgres /tmp/cw.dump
+```
+
+### Step 6: Update environment variables
+
+Modify the Postgres related environment variables to use the new RDS credentials.
+
+```bash
+sudo -i -u chatwoot
+cd chatwoot
+vi .env
+```
+
+### Step 7: Start Chatwoot service
+
+Start the Chatwoot service.
+
+```bash
+sudo systemctl start chatwoot.target
+```
+
+
+ If you are getting the Chatwoot onboarding screen again on visiting your self-hosted Chatwoot URL,
+ login to the rails console and run the following:
+
+ ```bash
+ sudo cwctl --console
+ ::Redis::Alfred.delete(::Redis::Alfred::CHATWOOT_INSTALLATION_ONBOARDING)
+ ```
+
\ No newline at end of file
diff --git a/self-hosted/runbooks/upgrade-to-chatwoot-v4.mdx b/self-hosted/runbooks/upgrade-to-chatwoot-v4.mdx
new file mode 100644
index 00000000..38984cf6
--- /dev/null
+++ b/self-hosted/runbooks/upgrade-to-chatwoot-v4.mdx
@@ -0,0 +1,125 @@
+---
+title: "How to upgrade to Chatwoot v4?"
+description: "Complete guide for upgrading to Chatwoot v4 with PostgreSQL pgvector support"
+---
+
+Chatwoot v4 requires PostgreSQL with `pgvector` support. You need to ensure that the version of PostgreSQL you are running supports `pgvector` before upgrading.
+
+## Type of Deployment
+
+### Linux
+- If you are using managed PostgreSQL, refer to the **Managed PostgreSQL** section below.
+- If you are using self-hosted PostgreSQL, read along.
+
+### Docker
+- If you are using managed PostgreSQL, refer to the **Managed PostgreSQL** section below.
+- If you are using self-hosted PostgreSQL, read along.
+
+### Kubernetes (Helm)
+- If you are using managed PostgreSQL, refer to the **Managed PostgreSQL** section below.
+- If you are using self-hosted PostgreSQL, read along.
+
+### Heroku
+- No action is needed if you are using Heroku PostgreSQL.
+- If you are using another managed PostgreSQL, refer to the **Managed PostgreSQL** section below.
+
+## PostgreSQL
+
+The PostgreSQL section is divided into parts based on how you are running PostgreSQL:
+1. **Managed PostgreSQL** from cloud vendors like AWS, GCP, Azure, Heroku, etc.
+2. **Self-hosted PostgreSQL** on Linux, Docker, or Kubernetes via Helm charts.
+
+### Managed PostgreSQL
+
+#### AWS RDS
+No action is needed if you are on the latest version of RDS.
+[Learn more](https://aws.amazon.com/about-aws/whats-new/2023/10/amazon-rds-postgresql-pgvector-hnsw-indexing/)
+
+#### Google Cloud (Cloud SQL)
+No action is needed.
+[Learn more](https://cloud.google.com/blog/products/databases/using-pgvector-llms-and-langchain-with-google-cloud-databases)
+
+#### Heroku PostgreSQL
+The `pgvector` extension is supported. No action is needed.
+[Learn more](https://devcenter.heroku.com/articles/pgvector-heroku-postgres)
+
+#### Azure PostgreSQL
+To enable `pgvector` on your Azure Database for PostgreSQL flexible server instance:
+
+1. Add `pgvector` to your allowlist as described in the PostgreSQL extensions documentation.
+2. Verify if it is correctly added by running:
+ ```sql
+ SHOW azure.extensions;
+ ```
+
+[Learn more](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-use-pgvector#enable-extension)
+
+---
+
+## Self-hosted PostgreSQL
+
+### Linux VM
+
+#### Existing Installation
+Install the `pgvector` extension for your version of PostgreSQL and run the upgrade:
+
+```bash
+# Find your PostgreSQL version
+psql --version
+
+# If its version 16, use the following command
+# Replace "16" with your PostgreSQL version
+sudo apt install postgresql-16-pgvector
+```
+
+### Docker Container
+
+#### Existing Installation
+
+1. Replace the PostgreSQL image with the pgvector image. The pgvector image is a drop-in replacement and works with your existing data:
+
+ ```bash
+ docker compose down
+
+ # Edit and replace the PostgreSQL image in docker-compose.yaml
+ vi docker-compose.yaml
+
+ # Replace PostgreSQL image tag
+ # Example: replace
+ # image: postgres:12
+ # with
+ # image: pgvector/pgvector:pg12
+
+ # Ensure the pg tag number matches your PostgreSQL version
+ docker compose pull
+
+ # Verify the updated setup
+ docker compose up -d
+ ```
+
+2. After verifying that the existing installation works with the pgvector image, proceed with the regular upgrade steps.
+ [Learn more](https://www.chatwoot.com/docs/self-hosted/deployment/upgrade#docker)
+
+### Kubernetes (Helm Chart)
+
+If you use the built-in PostgreSQL via the official Helm chart, follow the steps below. The Bitnami-packaged PostgreSQL used in the Helm chart does not support the pgvector extension. To address this, we have built a custom Postgres image with `pgvector` support.
+
+
+ This is only applicable if you are using the built-in Postgres with helm charts. Refer to the managed docs section if you are using AWS RDS or something similar.
+
+
+1. Create a `values.v4-upgrade.yaml` file with the following contents:
+
+ ```yaml
+ image:
+ repository: chatwoot/chatwoot
+ tag: v4.0.1
+ pullPolicy: IfNotPresent
+
+ postgresql:
+ image:
+ registry: ghcr.io
+ repository: chatwoot/pgvector
+ ```
+
+2. Run `helm upgrade` with this custom values.yaml file.
\ No newline at end of file
diff --git a/docs/self-hosted/supported-features.md b/self-hosted/supported-features.mdx
similarity index 91%
rename from docs/self-hosted/supported-features.md
rename to self-hosted/supported-features.mdx
index b7b07336..412a051b 100644
--- a/docs/self-hosted/supported-features.md
+++ b/self-hosted/supported-features.mdx
@@ -1,11 +1,9 @@
---
-sidebar_label: "Supported features"
-title: "Supported features on channels"
+title: "Supported Features on Channels"
+description: "Comprehensive reference for supported features, message types, and limitations across all Chatwoot channels"
---
-### Supported message type
-
-
+## Supported message type
| Channel | Incoming/Outgoing message | Activity message |
| --------- | ------------------------- | ---------------- |
@@ -19,11 +17,7 @@ title: "Supported features on channels"
| Line | Yes | Yes |
| API | Yes | Yes |
-
-
-### Maximum message size (number of characters)
-
-
+## Maximum message size (number of characters)
| Channel | Maximum message size |
| ------------------ | -------------------- |
@@ -40,11 +34,7 @@ title: "Supported features on channels"
| Line | 2000 |
| API | 10,000 |
-
-
-### Outbound conversation restriction
-
-
+## Outbound conversation restriction
| Channel | Restriction |
| --------- | --------------------------------------------------------------------------------------------------------------- |
@@ -58,11 +48,7 @@ title: "Supported features on channels"
| Line | Cannot create outbound conversations. First message should be from the contact |
| API | No restriction |
-
-
-### Outgoing message restriction
-
-
+## Outgoing message restriction
| Channel | Restriction |
| --------- | --------------------------------------------------------------------------------------------------------------- |
@@ -76,11 +62,7 @@ title: "Supported features on channels"
| Line | No restriction |
| API | Custom time depends on Agent reply time window |
-
-
-### Outgoing message delivery status
-
-
+## Outgoing message delivery status
| Channel | Sent status | Read status | Delivered status | Failed status |
| ------------------ | ----------- | ------------- | ---------------- | ------------- |
@@ -97,11 +79,7 @@ title: "Supported features on channels"
| Telegram | Yes | Not supported | Not supported | Yes |
| Email | Yes | Not supported | Not supported | Not supported |
-
-
-### Reply to message
-
-
+## Reply to message
| Channel | Reply to incoming message | Reply to outgoing message |
| --------------- | ------------------------- | ------------------------- |
@@ -116,13 +94,11 @@ title: "Supported features on channels"
| Line | No | No |
| API | Yes | Yes |
-
-
-### Outgoing attachments supported file types
+## Outgoing attachments supported file types
-> Note: The default maximum file size limit is 40MB.
-
-
+
+The default maximum file size limit is 40MB.
+
| Channel | Audio | Image | Video | Document |
| --------------- | ------------------------- | -------------------- | ------------------------------ | ------------- |
@@ -136,7 +112,8 @@ title: "Supported features on channels"
| Line | Not supported | png, jpeg | mp4 | Not supported |
| API | All | All | All | All |
-> "All" means the channel supports all standard file types listed below:
+
+"All" means the channel supports all standard file types listed below:
**Standard File Types**
@@ -144,12 +121,9 @@ title: "Supported features on channels"
- **Audio:** `mp3`, `mpeg`, `opus`, `ogg`, `amr`, `aac`, `m4a`, `wav`
- **Image:** `png`, `jpeg`, `gif`, `bmp`, `webp`
- **Document:** `pdf`, `doc`, `docx`, `xls`, `xlsx`, `ppt`, `pptx`, `zip`, `7z`, `rar`, `tar`, `xml`, `csv`, `json`, `rtf`, `txt`, `plain`, `.3gpp`, `x-7z-compressed`, `vnd.rar`, `x-tar`, `msword`
+
-
-
-### Available features
-
-
+## Available features
| Channel | Channel greeting | Attachments | Agent Auto assignment | Slack |
| --------- | ---------------- | ----------- | --------------------- | ----- |
@@ -161,6 +135,4 @@ title: "Supported features on channels"
| Email | Yes | Yes | Yes | Yes |
| Telegram | Yes | Yes | Yes | Yes |
| Line | Yes | No | Yes | Yes |
-| API | Yes | Yes | Yes | Yes |
-
-
+| API | Yes | Yes | Yes | Yes |
\ No newline at end of file
diff --git a/docs/self-hosted/telemetry.md b/self-hosted/telemetry.mdx
similarity index 74%
rename from docs/self-hosted/telemetry.md
rename to self-hosted/telemetry.mdx
index 2a94637e..916fa729 100644
--- a/docs/self-hosted/telemetry.md
+++ b/self-hosted/telemetry.mdx
@@ -1,13 +1,13 @@
---
-sidebar_label: "Telemetry"
title: "Telemetry"
+description: "Learn about Chatwoot's telemetry data collection, what data is collected, how it's used, and how to opt-out"
---
Chatwoot tracks usage of its products which helps the team to improve and deliver better software. You can opt-out of this telemetry at any time.
-## **What data is collected**
+## What data is collected
-None of your customer data is ever transmitted by Chatwoot installation. The telemetry data collected by our products are purely usage statics of various software features.
+None of your customer data is ever transmitted by Chatwoot installation. The telemetry data collected by our products are purely usage statistics of various software features.
### On-boarding
@@ -26,7 +26,7 @@ Chatwoot sends anonymised metadata to our telemetry instance at a defined interv
- Usage events on various feature interactions.
-## **How is the data used**
+## How is the data used
This data will only be used by Chatwoot team for:
@@ -34,7 +34,7 @@ This data will only be used by Chatwoot team for:
- Identifying areas with limited usage or where our users get stuck.
- Prioritizing the next set of features to be developed.
-## **How is the data collected and how will it be processed**
+## How is the data collected and how will it be processed
The telemetry data is stored securely on Chatwoot systems, with appropriate encryptions and access controls in place.
@@ -44,5 +44,14 @@ The self-hosted installation interacts with the URLs (hub.chatwoot.com, hub.2.ch
If you want to disable telemetry you can do the following.
-- **Disable data collection:** Use the environment variable 'DISABLE_TELEMETRY' in the installation. Set it to true to disable the data collection.
-- **Disable update email subscription:** While you signup, you have to option to disable the subscription to update emails. If the option is disabled, Chatwoot won't collect the emails.
+### Disable data collection
+
+Use the environment variable `DISABLE_TELEMETRY` in the installation. Set it to `true` to disable the data collection.
+
+```bash
+DISABLE_TELEMETRY=true
+```
+
+### Disable update email subscription
+
+While you signup, you have to option to disable the subscription to update emails. If the option is disabled, Chatwoot won't collect the emails.
\ No newline at end of file
diff --git a/sidebars.js b/sidebars.js
deleted file mode 100644
index 3bc980ca..00000000
--- a/sidebars.js
+++ /dev/null
@@ -1,7 +0,0 @@
-const contributingGuide = require("./config/sidebar/contributingGuide");
-const selfHosted = require("./config/sidebar/selfhosted");
-
-module.exports = {
- selfHosted,
- contributingGuide,
-};
diff --git a/src/css/custom.css b/src/css/custom.css
deleted file mode 100644
index cb917199..00000000
--- a/src/css/custom.css
+++ /dev/null
@@ -1,192 +0,0 @@
-/* stylelint-disable docusaurus/copyright-header */
-/**
- * Any CSS included here will be global. The classic template
- * bundles Infima by default. Infima is a CSS framework designed to
- * work well for content-centric websites.
- */
-
-/* You can override the default Infima variables here. */
-
-:root {
- --ifm-color-primary: #1f93ff;
- --ifm-color-primary-dark: #0285ff;
- --ifm-color-primary-darker: #007ef3;
- --ifm-color-primary-darkest: #0068c8;
- --ifm-color-primary-light: #3ca1ff;
- --ifm-color-primary-lighter: #4aa8ff;
- --ifm-color-primary-lightest: #75bcff;
- --ifm-footer-background-color: #fff;
- --ifm-code-font-size: 75%;
- --ifm-heading-family-base: 'Helvetica Neue', Helvetica, -apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
- --ifm-font-family-base: 'Helvetica Neue', Helvetica, -apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
- --doc-sidebar-width: 248px !important;
- --ifm-menu-link-padding-horizontal: 0.5rem;
- --ifm-menu-link-padding-vertical: 0.25rem;
- --ifm-menu-color-background-hover: transparent;
- --ifm-menu-color-background-active: transparent;
- --color-body: #23282e;
- --ifm-h1-font-size: calc(1.375rem + 1vw) !important;
- --ifm-navbar-height: 5rem;
- --ifm-navbar-link-font-size: 1.0625rem;
- --ifm-navbar-link-color: #506690;
- --ifm-h1-font-size: 2.4rem !important;
- --docusaurus-announcement-bar-height: 2.4rem !important;
-}
-
-.markdown {
- font-size: 1.1rem;
-}
-
-html[data-theme="light"] {
- --ifm-heading-color: #3c4858;
-}
-
-html[data-theme="light"] .markdown {
- color: var(--ifm-heading-color);
-}
-
-.docusaurus-highlight-code-line {
- background-color: rgb(72, 77, 91);
- display: block;
- margin: 0 calc(-1 * var(--ifm-pre-padding));
- padding: 0 var(--ifm-pre-padding);
-}
-
-body {
- -webkit-font-smoothing: antialiased;
- -moz-osx-font-smoothing: grayscale;
-}
-
-h1, h2, h3, h4, h5, h6 {
- font-family: var(--ifm-heading-family-base);
- font-weight: 600;
-}
-
-.navbar__title, .navbar__item {
- font-family: var(--ifm-heading-family-base);
-}
-
-@media screen and (min-width: 997px) {
- .menu {
- padding: 2.5rem 0.8rem !important;
- font-size: 0.875rem;
- }
-
- .mw-25 {
- max-width: 25%;
- }
-
- .mw-50 {
- max-width: 50%;
- }
-}
-
-@media screen and (max-width: 996px) {
- h1 {
- font-size: 2.4rem !important;
- }
-}
-
-
-.menu__link:hover {
- color: var(--ifm-color-primary);
-}
-
-.navbar__title {
- font-size: var(--ifm-navbar-link-font-size);
-}
-
-html[data-theme="light"] .navbar__title {
- color: var(--ifm-heading-color);
-}
-
-.navbar__link {
- font-size: var(--ifm-navbar-link-font-size);
-}
-
-.menu__link--sublist::after {
- background: var(--ifm-menu-link-sublist-icon) 50% / 1.5rem 1.5rem;
-}
-
-html[data-theme="light"] .navbar__link {
- color: var(--ifm-navbar-link-color);
-}
-
-.menu__list {
- margin: 0.25rem 0 1.5rem;
-}
-
-.menu__list .menu__list-item {
- text-transform: uppercase;
- font-weight: 600;
- font-size: 0.75rem;
- font-family: var(--ifm-heading-family-base);
- letter-spacing: 0;
-}
-
-.menu__list .menu__list .menu__list-item {
- font-weight: 400;
- text-transform: none;
- font-size: 1rem;
- font-family: var(--ifm-font-family-base);
- color: rgb(80, 102, 144);
-}
-
-
-.table-of-contents {
- font-size: 1rem;
-}
-
-html[data-theme="light"] .navbar__link:hover,
-html[data-theme="light"] .navbar__link--active {
- color: var(--ifm-navbar-link-hover-color) !important;
-}
-
-.d-block {
- display: block;
-}
-
-.markdown {
- padding: 1rem 2.4rem;
-}
-
-.theme-doc-breadcrumbs {
- padding: 1rem 2.4rem 0;
-}
-
-@media screen and (max-width: 997px) {
- .markdown {
- padding: 0.8rem;
- }
-}
-
-.markdown h1:first-child {
- --ifm-h1-font-size: 2.4rem;
-}
-
-.doc-page--footer {
- padding: 2.4rem;
- margin-top: 1rem;
- background: var(--ifm-color-secondary-lightest);
- border-radius: 8px;
-}
-
-.doc-page--footer--edit {
- display: flex;
- justify-content: space-between;
-}
-
-@media screen and (max-width: 997px) {
- .doc-page--footer--edit {
- flex-direction: column;
- }
-
- div[class^='announcementBar_'] {
- height: 4rem;
- }
-}
-
-div[class^='announcementBar_'] {
- background-color: var(--ifm-color-primary);
- color: #fff;
-}
diff --git a/src/theme/DocItemFooter/index.js b/src/theme/DocItemFooter/index.js
deleted file mode 100644
index 075aa7b7..00000000
--- a/src/theme/DocItemFooter/index.js
+++ /dev/null
@@ -1,78 +0,0 @@
-import React from 'react';
-import clsx from 'clsx';
-
-import LastUpdated from '@theme/LastUpdated';
-import EditThisPage from '@theme/EditThisPage';
-import TagsListInline from '@theme/TagsListInline';
-function TagsRow(props) {
- return (
-
- );
-}
-
-function EditMetaRow({
- editUrl,
- lastUpdatedAt,
- lastUpdatedBy,
- formattedLastUpdatedAt,
-}) {
- return (
-
-
{editUrl && }
-
-
- {(lastUpdatedAt || lastUpdatedBy) && (
-
- )}
-
-
+
+## Join Our Contributors
+
+Ready to make your mark on Chatwoot? Here's how to get started:
+
+### Quick Start
+
+1. **Star the Repository**: [Star Chatwoot on GitHub](https://github.com/chatwoot/chatwoot)
+2. **Join Discord**: [Join our Discord community](https://discord.com/invite/cJXdrwS)
+3. **Pick an Issue**: Find a [good first issue](https://github.com/chatwoot/chatwoot/labels/good%20first%20issue)
+4. **Make Your First Contribution**: Follow our [contribution guide](/contributing-guide)
+
+### Stay Connected
+
+- **GitHub**: [github.com/chatwoot/chatwoot](https://github.com/chatwoot/chatwoot)
+- **Discord**: [discord.com/invite/cJXdrwS](https://discord.com/invite/cJXdrwS)
+- **Twitter**: [@chatwootapp](https://twitter.com/chatwootapp)
+- **LinkedIn**: [Chatwoot Company Page](https://www.linkedin.com/company/chatwoot)
+
+---
+
+Every contribution, no matter how small, makes Chatwoot better for thousands of users worldwide. Thank you for considering joining our contributor community! 🙏
diff --git a/contributing-guide/environment-setup/docker.mdx b/contributing-guide/environment-setup/docker.mdx
new file mode 100644
index 00000000..e3bc10a7
--- /dev/null
+++ b/contributing-guide/environment-setup/docker.mdx
@@ -0,0 +1,283 @@
+---
+title: Docker Development Setup
+description: Complete guide to setting up Chatwoot development environment using Docker and Docker Compose.
+sidebarTitle: Docker Setup
+---
+
+# Docker Development Setup
+
+This guide will help you set up a complete Chatwoot development environment using Docker and Docker Compose.
+
+## Pre-requisites
+
+Before proceeding, make sure you have the latest version of `docker` and `docker-compose` installed.
+
+As of now, we recommend a version equal to or higher than the following:
+
+```bash
+$ docker --version
+Docker version 25.0.4, build 1a576c5
+$ docker compose --version
+docker-compose version 2.24.7
+```
+
+### Install Docker
+
+#### Windows
+
+1. **Download Docker Desktop** from [https://www.docker.com/products/docker-desktop/](https://www.docker.com/products/docker-desktop/)
+2. **Run the installer** and follow setup instructions
+3. **Enable WSL2 backend** (recommended)
+4. **Restart your computer** when prompted
+
+#### macOS
+
+```bash
+# Option 1: Download from website
+# Go to https://www.docker.com/products/docker-desktop/
+
+# Option 2: Using Homebrew
+brew install --cask docker
+```
+
+#### Linux (Ubuntu/Debian)
+
+```bash
+# Update package index
+sudo apt update
+
+# Install dependencies
+sudo apt install -y apt-transport-https ca-certificates curl gnupg lsb-release
+
+# Add Docker's official GPG key
+curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+
+# Add Docker repository
+echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+
+# Install Docker
+sudo apt update
+sudo apt install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
+
+# Add user to docker group
+sudo usermod -aG docker $USER
+
+# Start Docker service
+sudo systemctl start docker
+sudo systemctl enable docker
+```
+
+
+
+## Step 2: Enable Windows Subsystem for Linux
+
+Next you have to enable the Windows Subsystem for Linux. Open the "Control Panel" and go to "Programs and Features". Click on the link on the left "Turn Windows features on or off". Look for the "Windows Subsystem for Linux" option and select the checkbox next to it.
+
+
+
+You'll also need to enable "Virtual Machine Platform" for WSL2. Make sure both checkboxes are selected:
+- ✅ Windows Subsystem for Linux
+- ✅ Virtual Machine Platform
+
+After enabling these features, restart your computer.
+
+## Step 3: Install WSL2 and Ubuntu
+
+### Option 1: Using Microsoft Store (Recommended)
+
+1. **Open Microsoft Store** and search for "Ubuntu"
+2. **Install Ubuntu 22.04 LTS** (or latest LTS version)
+3. **Launch Ubuntu** from the Start Menu
+
+### Option 2: Using Command Line
+
+Open PowerShell as Administrator and run:
+
+```powershell
+# Install WSL2 with Ubuntu
+wsl --install -d Ubuntu-22.04
+
+# Set WSL2 as default version
+wsl --set-default-version 2
+```
+
+## Step 4: Initial Ubuntu Setup
+
+When you first launch Ubuntu, you'll be prompted to create a user account:
+
+```bash
+# Create a username and password when prompted
+# This will be your Linux user account
+```
+
+Update the system packages:
+
+```bash
+sudo apt update && sudo apt upgrade -y
+```
+
+## Step 5: Install Core Dependencies
+
+You need core Linux dependencies installed in order to install Ruby and other tools.
+
+```bash
+sudo apt-get update
+sudo apt-get install -y git-core curl zlib1g-dev build-essential libssl-dev libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev software-properties-common libffi-dev
+```
+
+## Installing RVM & Ruby
+
+Install additional dependencies required for RVM:
+
+```bash
+sudo apt-get install -y libgdbm-dev libncurses5-dev automake libtool bison libffi-dev
+```
+
+Install RVM & Ruby version 3.2.2:
+
+```bash
+# Add RVM GPG keys
+gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+
+# Install RVM
+curl -sSL https://get.rvm.io | bash -s stable
+
+# Load RVM into current session
+source ~/.rvm/scripts/rvm
+
+# Install Ruby 3.2.2
+rvm install 3.2.2
+rvm use 3.2.2 --default
+
+# Verify installation
+ruby -v
+```
+
+## Install Node.js
+
+Chatwoot requires Node.js version 20. Install Node.js from NodeSource using the following commands:
+
+```bash
+curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+sudo apt-get install -y nodejs
+```
+
+Verify Node.js installation:
+
+```bash
+node --version
+# Should output: v20.x.x
+```
+
+## Install pnpm
+
+We use `pnpm` as the package manager for better performance:
+
+```bash
+# Install pnpm globally
+npm install -g pnpm
+
+# Verify installation
+pnpm --version
+```
+
+## Install PostgreSQL
+
+The database used in Chatwoot is PostgreSQL. Use the following commands to install PostgreSQL:
+
+```bash
+sudo apt install -y postgresql postgresql-contrib
+```
+
+The installation procedure created a user account called postgres that is associated with the default Postgres role. In order to use PostgreSQL, you can log into that account:
+
+```bash
+sudo -u postgres psql
+```
+
+Install `libpq-dev` dependencies for Ubuntu:
+
+```bash
+sudo apt-get install -y libpq-dev
+```
+
+Start PostgreSQL service:
+
+```bash
+sudo service postgresql start
+```
+
+Configure PostgreSQL to start automatically:
+
+```bash
+echo 'sudo service postgresql start' >> ~/.bashrc
+```
+
+Create a database user:
+
+```bash
+# Switch to postgres user and create a superuser
+sudo -u postgres createuser --superuser $USER
+
+# Set password for your user
+sudo -u postgres psql -c "ALTER USER $USER PASSWORD 'password';"
+```
+
+## Install Redis Server
+
+Chatwoot uses Redis server for agent assignments and reporting. To install `redis-server`:
+
+```bash
+sudo apt-get install -y redis-server
+```
+
+Start Redis service:
+
+```bash
+sudo service redis-server start
+```
+
+Configure Redis to start automatically:
+
+```bash
+echo 'sudo service redis-server start' >> ~/.bashrc
+```
+
+Enable Redis to start on system boot:
+
+```bash
+sudo systemctl enable redis-server.service
+```
+
+## Install ImageMagick
+
+Chatwoot uses ImageMagick for image processing:
+
+```bash
+sudo apt-get install -y imagemagick libmagickwand-dev
+```
+
+## Configure Git
+
+Set up Git with your information:
+
+```bash
+git config --global user.name "Your Name"
+git config --global user.email "your.email@example.com"
+```
+
+## Windows-Specific Configuration
+
+### Install VS Code with WSL Extension
+
+1. **Install Visual Studio Code** on Windows from [https://code.visualstudio.com/](https://code.visualstudio.com/)
+2. **Install Remote - WSL extension** from the Extensions marketplace
+3. **Open your project in WSL** by running `code .` from your WSL terminal
+
+### Configure File Permissions
+
+WSL2 may have file permission issues. Fix them:
+
+```bash
+# Add to ~/.bashrc for better file permissions
+echo 'umask 022' >> ~/.bashrc
+
+# Configure Git to ignore file mode changes
+git config --global core.filemode false
+```
+
+## Environment Verification
+
+Verify all installations are working correctly:
+
+```bash
+# Check all versions
+ruby --version # Should be 3.2.2
+node --version # Should be v20.x.x
+pnpm --version # Should show pnpm version
+psql --version # Should show PostgreSQL version
+redis-cli ping # Should output: PONG
+convert --version # Should show ImageMagick version
+git --version # Should show Git version
+```
+
+## Troubleshooting Common Issues
+
+.default})
-
-2. Next you have to enable the Windows Subsystem for Linux. Open the "Control Panel" and go to "Programs and Features". Click on the link on the left "Turn Windows features on or off". Look for the "Windows Subsystem for Linux" option and select the checkbox next to it.
-
-.default})
-
-3. Once that's complete, you can open up the Start Menu again and search for "Bash". This time it will have the Ubuntu logo.
-
-### Installing RVM & Ruby
-
-You need core linux dependencies installed in order to install ruby.
-
-```bash
-sudo apt-get update
-sudo apt-get install git-core curl zlib1g-dev build-essential libssl-dev libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev software-properties-common libffi-dev
-```
-
-Install RVM & ruby version 3.2.2
-
-```bash
-sudo apt-get install libgdbm-dev libncurses5-dev automake libtool bison libffi-dev
-gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
-curl -sSL https://get.rvm.io | bash -s stable
-source ~/.rvm/scripts/rvm
-rvm install 3.2.2
-rvm use 3.2.2 --default
-ruby -v
-```
-
-### Install Node.js
-
-Chatwoot requires `node` version `20`. Install `Node.js` from NodeSource using the following commands
-
-```bash
-curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -
-sudo apt-get install -y nodejs
-```
-
-### Install pnpm
-
-We use `pnpm` as the package manager
-
-```bash
-iwr https://get.pnpm.io/install.ps1 -useb | iex
-```
-
-### Install postgres
-
-The database used in Chatwoot is PostgreSQL. Use the following commands to install postgres:
-
-```bash
-sudo apt install postgresql postgresql-contrib
-```
-
-The installation procedure created a user account called postgres that is associated with the default Postgres role. In order to use Postgres, you can log into that account.
-
-```bash
-sudo -u postgres psql
-```
-
-Install `libpg-dev` dependencies for Ubuntu
-
-```bash
-sudo apt-get install libpq-dev
-sudo service postgresql start
-```
-
-### Install redis-server
-
-Chatwoot uses Redis server in agent assignments and reporting. To install `redis-server`
-
-```bash
-sudo apt-get install redis-server
-```
-
-Enable Redis to start on system boot.
-
-```bash
-sudo systemctl enable redis-server.service
-```
-
-### Install imagemagick
-
-```bash
-sudo apt-get install imagemagick
-```
diff --git a/docs/contributing-guide/environment-variables.md b/docs/contributing-guide/environment-variables.md
deleted file mode 100644
index 69cc55f8..00000000
--- a/docs/contributing-guide/environment-variables.md
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: 'Environment variables'
----
-
-For a complete set of production environment variables, please refer to [Production Environment Variables Guide](/docs/self-hosted/configuration/environment-variables)
-
-In addition to the above variables, you can use the following variables in development mode.
-
-### Use letter opener instead of mailhog/SMTP
-
-Set the following variable to open emails in letter opener instead of SMTP
-
-```
-LETTER_OPENER=true
-```
diff --git a/docs/contributing-guide/line-channel-setup.md b/docs/contributing-guide/line-channel-setup.md
deleted file mode 100644
index c099d8e0..00000000
--- a/docs/contributing-guide/line-channel-setup.md
+++ /dev/null
@@ -1,19 +0,0 @@
----
-sidebar_label: "Line App"
-title: "Setup Line app integration on your local machine"
----
-
-Please follow the steps if you are trying to work with the Line integration on your local machine.
-
-- Start a Ngrok server listening at port `3000` or the port you will be running the Chatwoot installation.
-- Update the .env variable FRONTEND_URL in Chatwoot with the `https` version of the Ngrok URL.
-- Start the Chatwoot server and create a new Line channel with the below values obtained from [Line Developer Console](https://developers.line.biz/console) under the "Messaging API" channel.
-
-1. Channel Name
-2. LINE Channel ID
-3. LINE Channel Secret
-4. LINE Channel Token
-
-After creating the channel, Chatwoot will provide a webhook URL for the channel. You can configure this webhook url in the [Line Developer Console](https://developers.line.biz/console) under the "Messaging API" channel.
-
-If the webhook is registered correctly with Line, your Ngork server should receive events for new Line messages, and new conversations will be created in Chatwoot.
diff --git a/docs/contributing-guide/mobile-app/custom-release-guide.md b/docs/contributing-guide/mobile-app/custom-release-guide.md
deleted file mode 100644
index a6cdd2d3..00000000
--- a/docs/contributing-guide/mobile-app/custom-release-guide.md
+++ /dev/null
@@ -1,52 +0,0 @@
----
-sidebar_label: "Custom Release Guide"
-title: "Custom release guide for mobile app"
----
-
-### Set up Firebase for Push Notifications
-
-Note: If you're using the official mobile app, you can skip this step. Push notifications should work correctly as long as the `ENABLE_PUSH_RELAY_SERVER` environment variable is set to true in the Chatwoot environment variables.
-
-- Start by creating a new project in the [Firebase console](https://console.firebase.google.com/).
-- Next, generate [Android credentials](https://rnfirebase.io/#generating-android-credentials) from the Firebase console. Download the `google-services.json` file and place it within your project at the following location: `android/app/`.
-- Generate [iOS credentials](https://rnfirebase.io/#generating-ios-credentials) from the Firebase console. Download the `GoogleService-Info.plist` file and add it to your project using `Xcode`. More details are available [here](https://rnfirebase.io/#3-ios-setup).
-- Follow the [guide](https://firebase.google.com/docs/cloud-messaging/migrate-v1) to generate GOOGLE_APPLICATION_CREDENTIALS.
-- Visit `.default})
+
+
- `Installation Identifier`: This is the unique identifier used to identify an installation and associate a license with that installation.
- `Manage Plan`: Redirects to the Stripe portal where you can purchase the appropriate number of licenses.
@@ -29,6 +30,7 @@ Our pricing plans start at $19 per agent per month. For more detailed informatio
No, at the moment Chatwoot only offers per agent per month plans. If you are looking at a large number of agents, you can reach out to us at `sales@chatwoot.com` for custom plans.
### Transferring licenses?
+
If you are moving the installation between servers and doing so with a database backup, the original installation identifier is retained, and you don't need to activate the license again.
-If for some reason you decide to delete an existing licensed installation and want to do a new installation, please reach out to Chatwoot support, and our team can help you transfer the license to your new installation.
+If for some reason you decide to delete an existing licensed installation and want to do a new installation, please reach out to Chatwoot support, and our team can help you transfer the license to your new installation.
\ No newline at end of file
diff --git a/docs/self-hosted/faq.md b/self-hosted/faq.mdx
similarity index 76%
rename from docs/self-hosted/faq.md
rename to self-hosted/faq.mdx
index 7586c503..3c169551 100644
--- a/docs/self-hosted/faq.md
+++ b/self-hosted/faq.mdx
@@ -1,11 +1,10 @@
---
-sidebar_label: 'FAQ'
-title: 'Frequently asked questions'
+title: 'Frequently Asked Questions'
+description: 'Common questions and answers about self-hosted Chatwoot installation, support, and best practices'
---
This document is a place to search for frequently asked questions in the Chatwoot community about the processes, support and best practices.
-
## How to get support?
The chatwoot team provides support over the following channels. Please choose the appropriate medium based on the type of your query and resolution expectations.
@@ -18,19 +17,19 @@ The chatwoot team provides support over the following channels. Please choose th
**Premium Support**: Available for customers having a commerical contract with Chatwoot or subscribers of a paid plan. This includes both Chatwoot Cloud Customers and Self-hosted Customers.
-
-| Channel Type | Response Expectations | Query Types
+| Channel Type | Response Expectations | Query Types |
|----------|-------------|------|
-| Chat Wiget | Real-time responses based on online agent availability. Cloud customers can use the in-product Support option for priority resolutions. 
### Go to the App Review Section
Go to the Instagram product and click on "Go to App Review".
-
+
### Confirm the Documentation
Click on "Continue" to confirm the documentation.
-
+
### Select the Permissions
Select the permissions `instagram_business_basic`, `instagram_business_manage_messages`, and `human_agent` and click on "Continue to App Review".
-
+
### Configure App Review Requests
After clicking on "Continue to App Review", you will be redirected to the App Review requests page.
-
+
Click on the "Edit" button to edit the review request.
-
+
### Business Account
You **must** have a Business Account to be able to request these permissions. Please ensure you have a Business Account before requesting the permissions. Submit Business Account details.
-
+
### Data Handling
Please answer all the questions in the Data Handling section and include all the pre-processing steps you perform on the data.
-
+
-
+
### Complete App Settings
Make sure you have an app icon, privacy policy URL, and app category configured. You can update these via the Basic Settings.
-
+
### Review Instructions
Provide the review instructions to the reviewer for the App Review. Essentially, you need to provide the steps to log in to the Dashboard and send a message to the connected Instagram account.
-
+
You can use the following template to provide the review instructions:
@@ -89,13 +87,13 @@ You can use the following template to provide the review instructions:
6. Once the setup is complete, you can send a message to the connected Instagram account.
7. The message should appear on the Dashboard at `[DASHBOARD_URL]/app/accounts/[ACCOUNT_ID]/dashboard`.
-
+
## Permissions
It is time to request the permissions. Please click on each permission and fill in the details. Once you are done, click on "Submit for Review". Below are sample permission requests you can use as a reference.
-
+
## `instagram_business_basic`
@@ -214,8 +212,10 @@ Include a screencast demonstrating the following steps:
- Do not include Instagram account credentials.
- Only share test Dashboard credentials (non-super admin access recommended).
- Ensure your screencast clearly shows the platform UI and relevant workflows.
-- Keep your permission usage aligned with Meta’s policy for message tags and user privacy.
+- Keep your permission usage aligned with Meta's policy for message tags and user privacy.
- Speak aloud or add captions in your video for reviewer clarity.
- Video should be as detailed as possible.
-> 💡 **Tip:** Use a screen recorder that captures mouse interactions, popups, and browser activity to clearly demonstrate authentication flows and inbox interactions.
+