admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add doc link in env file (#3277)

Browse Source
This commit is contained in:
martmull
2024-01-08 10:42:03 +01:00
committed by GitHub
parent 96264e264c
commit d2e8df52cf
4 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/twenty-docs/docs/start/self-hosting/enviroment-variables.mdx → packages/twenty-docs/docs/start/self-hosting/environment-variables.mdx
View File

@ -1,5 +1,5 @@
--- ---
title: Enviroment Variables title: Environment Variables
sidebar_position: 1 sidebar_position: 1
sidebar_custom_props: sidebar_custom_props:
icon: TbVariable icon: TbVariable
@ -156,5 +156,5 @@ import TabItem from '@theme/TabItem';
<OptionTable options={[ <OptionTable options={[
['DEBUG_MODE', 'true', 'Activate debug mode'], ['DEBUG_MODE', 'true', 'Activate debug mode'],
['SIGN_IN_PREFILLED', 'true', 'Prefill the Signin form for usage in a demo or dev enviroment'], ['SIGN_IN_PREFILLED', 'true', 'Prefill the Signin form for usage in a demo or dev environment'],
]}></OptionTable> ]}></OptionTable>

2
packages/twenty-docs/docs/start/self-hosting/self-hosting.mdx
View File

@ -11,7 +11,7 @@ Feel free to open issues on [GitHub](https://github.com/twentyhq/twenty/issues/n
Prebuilt images for both front and back-end can be found on [docker hub](https://hub.docker.com/r/twentycrm/). Prebuilt images for both front and back-end can be found on [docker hub](https://hub.docker.com/r/twentycrm/).
For correct operation your will need to set [environment variables](enviroment-variables), a example configuration can be found [here](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/.env.example). For correct operation your will need to set [environment variables](environment-variables), a example configuration can be found [here](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/.env.example).
## Render ## Render

1
packages/twenty-server/.env.example
View File

@ -39,6 +39,7 @@ SIGN_IN_PREFILLED=true
# REDIS_PORT=6379 # REDIS_PORT=6379
# DEMO_WORKSPACE_IDS=REPLACE_ME_WITH_A_RANDOM_UUID # DEMO_WORKSPACE_IDS=REPLACE_ME_WITH_A_RANDOM_UUID
# SERVER_URL=http://localhost:3000 # SERVER_URL=http://localhost:3000
# Email Server Settings, see this doc for more info: https://docs.twenty.com/start/self-hosting/environment-variables
# EMAIL_DRIVER=logger # EMAIL_DRIVER=logger
# EMAIL_SMTP_HOST= # EMAIL_SMTP_HOST=
# EMAIL_SMTP_PORT= # EMAIL_SMTP_PORT=

6
packages/twenty-utils/dangerfile.ts
View File

@ -18,16 +18,16 @@ if (packageChanged && !lockfileChanged) {
warn(`${message} - <i>${idea}</i>`); warn(`${message} - <i>${idea}</i>`);
} }
// Check if .env.example was changed, but not enviroment variable documentation // Check if .env.example was changed, but not environment variable documentation
const envChanged = const envChanged =
danger.git.modified_files.find((x) => x.includes('.env.example')) || danger.git.modified_files.find((x) => x.includes('.env.example')) ||
danger.git.modified_files.find((x) => x.includes('environment.service.ts')); danger.git.modified_files.find((x) => x.includes('environment.service.ts'));
const envDocsChanged = danger.git.modified_files.includes( const envDocsChanged = danger.git.modified_files.includes(
'enviroment-variables.mdx', 'environment-variables.mdx',
); );
if (envChanged && !envDocsChanged) { if (envChanged && !envDocsChanged) {
const message = const message =
'Changes were made to the enviroment variables, but not to the documentation'; 'Changes were made to the environment variables, but not to the documentation';
const idea = const idea =
'Please review your changes and check if a change needs to be documented!'; 'Please review your changes and check if a change needs to be documented!';
warn(`${message} - <i>${idea}</i>`); warn(`${message} - <i>${idea}</i>`);