update setup docs - config variables #12370
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR significantly updates the setup documentation by introducing a hybrid configuration management approach that combines environment variables with an admin panel interface, making configuration more user-friendly and maintainable.
- Added admin panel configuration section detailing user access controls and configurable settings
- Introduced configuration modes (Default/Environment-Only) with clear explanations of each mode's behavior
- Clarified essential infrastructure variables that must remain in
.envfiles - Added multi-container deployment considerations for database configuration
- Improved documentation structure with clearer separation between environment-only and admin-panel configurable variables
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
|
TODO:
|
packages/twenty-website/src/content/developers/self-hosting/setup.mdx
Outdated
Show resolved
Hide resolved
packages/twenty-website/src/content/developers/self-hosting/setup.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| **Most configuration can be managed through the Admin Panel** once your instance is running: |
There was a problem hiding this comment.
Can we have this run automatically so that users don't have to think about it during setup?
"yarn command:prod cron:messaging:messages-import
yarn command:prod cron:messaging:message-list-fetch
yarn command:prod cron:calendar:calendar-event-list-fetch
yarn command:prod cron:calendar:calendar-events-import
yarn command:prod cron:messaging:ongoing-stale
yarn command:prod cron:calendar:ongoing-stale
yarn command:prod cron:workflow:automated-cron-trigger"
Maybe create one super command or integrate it as part of the upgrade... Never dug into this so not 100% sure what they do. But it would help us keep the docs focused on Env Var only
There was a problem hiding this comment.
Can be in another PR of course
packages/twenty-website/src/content/developers/self-hosting/setup.mdx
Outdated
Show resolved
Hide resolved
| @@ -25,12 +25,12 @@ See docs [Setup Environment Variables](https://twenty.com/developers/section/sel | |||
|
|
|||
| Install the latest stable version of Twenty with a single command: | |||
| ```bash | |||
| bash <(curl -sL https://git.new/20) | |||
| bash <(curl -sL https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-docker/scripts/install.sh) | |||
There was a problem hiding this comment.
temporary! till we get short link working
packages/twenty-website/src/content/developers/self-hosting/setup.mdx
Outdated
Show resolved
Hide resolved
packages/twenty-website/src/content/developers/self-hosting/setup.mdx
Outdated
Show resolved
Hide resolved
closes twentyhq/core-team-issues#958