From aba7437fd5c3f6e93d19ab59a1ff0b2330949e6e Mon Sep 17 00:00:00 2001
From: BOHEUS <56270748+BOHEUS@users.noreply.github.com>
Date: Tue, 21 Oct 2025 17:02:39 +0000
Subject: [PATCH] Update documentation (#14891)
Fix small things and update documentation with more troubleshooting
information
---
packages/twenty-website/README.md | 2 +-
.../self-hosting/cloud-providers.mdx | 22 ++++++++++--
.../self-hosting/troubleshooting.mdx | 35 +++++++++++++++++++
.../developers/self-hosting/upgrade-guide.mdx | 2 +-
.../user-guide/collaboration/notes.mdx | 6 ++--
.../user-guide/collaboration/tasks.mdx | 4 +--
.../data-model/creating-records.mdx | 2 +-
.../data-model/customize-your-data-model.mdx | 2 +-
.../content/user-guide/data-model/fields.mdx | 4 +--
.../configure-workspace-in-three-steps.mdx | 26 +++++++-------
.../getting-started/getting-around-twenty.mdx | 6 ++--
.../implementation-services.mdx | 2 +-
.../user-guide/integrations/api-webhooks.mdx | 8 ++---
.../user-guide/integrations/emails.mdx | 2 +-
.../getting-started-workflows.mdx | 6 ++--
.../user-guide/integrations/integrations.mdx | 2 --
.../pricing/billing-and-pricing-faq.mdx | 14 ++++----
.../user-guide/settings/permissions.mdx | 2 +-
.../user-guide/settings/settings-faq.mdx | 4 +--
.../content/user-guide/views/kanban-views.mdx | 8 ++---
.../user-guide/views/views-sort-filter.mdx | 12 +++----
21 files changed, 111 insertions(+), 60 deletions(-)
diff --git a/packages/twenty-website/README.md b/packages/twenty-website/README.md
index 07d8ddbacb..0944f14957 100644
--- a/packages/twenty-website/README.md
+++ b/packages/twenty-website/README.md
@@ -5,7 +5,7 @@ This is not related in any way to the main app, which you can find in twenty-fro
## Getting Started
-We're using Next.JS
+We're using Next.js
We're using Postgres for the database. Mandatory for the website to work, even locally.
1. Copy the .env.example file to .env and fill in the values.
diff --git a/packages/twenty-website/src/content/developers/self-hosting/cloud-providers.mdx b/packages/twenty-website/src/content/developers/self-hosting/cloud-providers.mdx
index fa20fc0e2b..6a5dc7e5fe 100644
--- a/packages/twenty-website/src/content/developers/self-hosting/cloud-providers.mdx
+++ b/packages/twenty-website/src/content/developers/self-hosting/cloud-providers.mdx
@@ -12,10 +12,24 @@ image: /images/user-guide/notes/notes_header.png
Community-led documentation for Kubernetes deployment is available [here](https://github.com/twentyhq/twenty/tree/main/packages/twenty-docker/k8s)
+### Coolify
-## Others
+Deploy Twenty on servers using Coolify. (official image on Coolify will be available soon)
-Please feel free to Open a PR to add more Cloud Provider options.
+[Coolify documentation](https://coolify.io/docs/get-started/introduction)
+
+
+### EasyPanel
+
+Deploy Twenty on EasyPanel with the community maintained template below.
+
+[Deploy on EasyPanel](https://easypanel.io/docs/templates/twenty)
+
+### Elest.io
+
+Deploy Twenty on servers with Elest.io using link below.
+
+[Deploy on Elest.io](https://elest.io/open-source/twenty)
### Twenty on Railway
@@ -23,4 +37,8 @@ Deploy Twenty on Railway with the community maintained template below.
[](https://railway.com/deploy/nAL3hA)
+## Others
+
+Please feel free to Open a PR to add more Cloud Provider options.
+
diff --git a/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx b/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx
index d9d04166eb..1b764e91a4 100644
--- a/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx
+++ b/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx
@@ -120,6 +120,37 @@ That's expected as user is unauthorized when logged out since its identity is no
- If a **POST request** is received, your worker is running successfully. Otherwise, you need to troubleshoot your worker.
+#### Front-end fails to start and returns error TS5042: Option 'project' cannot be mixed with source files on a command line
+
+Comment out checker plugin in `packages/twenty-ui/vite-config.ts` like in example below
+```
+plugins: [
+ react({ jsxImportSource: '@emotion/react' }),
+ tsconfigPaths(),
+ svgr(),
+ dts(dtsConfig),
+ // checker(checkersConfig),
+ wyw({
+ include: [
+ '**/OverflowingTextWithTooltip.tsx',
+ '**/Chip.tsx',
+ '**/Tag.tsx',
+ '**/Avatar.tsx',
+ '**/AvatarChip.tsx',
+ ],
+ babelOptions: {
+ presets: ['@babel/preset-typescript', '@babel/preset-react'],
+ },
+ }),
+ ],
+```
+
+#### Admin panel not accessible
+
+Run `UPDATE core."user" SET "canAccessFullAdminPanel" = TRUE WHERE email = 'you@yourdomain.com';` in database container to get access to admin panel.
+
+
+
### 1-click Docker compose
#### Unable to Log In
@@ -155,6 +186,10 @@ If you're running Twenty behind a reverse proxy and experiencing connection issu
After making changes, restart both the reverse proxy and Twenty containers.
+#### Error when uploading an image - permission denied
+
+Switching the data folder ownership on the host from root to another user and group resolves this problem.
+
## Getting Help
If you encounter issues not covered in this guide:
diff --git a/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx b/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx
index 3a3422a4c2..d9e9c0c832 100644
--- a/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx
+++ b/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx
@@ -21,7 +21,7 @@ If you used Docker Compose, follow these steps:
If you want to upgrade your instance by few versions, e.g. from v0.33.0 to v0.35.0, you have to upgrade your instance sequentially, in this example from v0.33.0 to v0.34.0, then from v0.34.0 to v0.35.0.
-
+**Make sure that after each upgraded version you have non-corrupted backup.**
## Version-specific upgrade steps
diff --git a/packages/twenty-website/src/content/user-guide/collaboration/notes.mdx b/packages/twenty-website/src/content/user-guide/collaboration/notes.mdx
index 61bcba0bee..91004129f3 100644
--- a/packages/twenty-website/src/content/user-guide/collaboration/notes.mdx
+++ b/packages/twenty-website/src/content/user-guide/collaboration/notes.mdx
@@ -20,7 +20,7 @@ Creating notes in the system is intuitive and dynamic. You can either:
### Adding Content
-Start typing directly or press '/' to add elements like headings, files, or images instantly.
+Start typing directly or press `/` to add elements like headings, files, or images instantly.
### Format Content
@@ -28,7 +28,7 @@ You can format your notes right from the editor. Use Markdown syntax, press the
Highlight the text to see more formatting options like bold, italics, and alignment options.
-You can also change the background color and text color of each block to highlight important things in your note. To do so, hover over the block you want to format and click on the `⋮⋮` icon besides the `+` icon. Click on Colors to open up all color options for both the text and the background.
+You can also change the background color and text color of each block to highlight important things in your note. To do so, hover over the block you want to format and click on the `⋮` icon besides the `+` icon. Click on Colors to open up all color options for both the text and the background.