mirror of
https://github.com/twentyhq/twenty.git
synced 2024-10-27 03:33:21 +03:00
Add doc link in env file (#3277)
This commit is contained in:
parent
96264e264c
commit
d2e8df52cf
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Enviroment Variables
|
||||
title: Environment Variables
|
||||
sidebar_position: 1
|
||||
sidebar_custom_props:
|
||||
icon: TbVariable
|
||||
@ -156,5 +156,5 @@ import TabItem from '@theme/TabItem';
|
||||
|
||||
<OptionTable options={[
|
||||
['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>
|
@ -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/).
|
||||
|
||||
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
|
||||
|
@ -39,6 +39,7 @@ SIGN_IN_PREFILLED=true
|
||||
# REDIS_PORT=6379
|
||||
# DEMO_WORKSPACE_IDS=REPLACE_ME_WITH_A_RANDOM_UUID
|
||||
# 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_SMTP_HOST=
|
||||
# EMAIL_SMTP_PORT=
|
||||
|
@ -18,16 +18,16 @@ if (packageChanged && !lockfileChanged) {
|
||||
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 =
|
||||
danger.git.modified_files.find((x) => x.includes('.env.example')) ||
|
||||
danger.git.modified_files.find((x) => x.includes('environment.service.ts'));
|
||||
const envDocsChanged = danger.git.modified_files.includes(
|
||||
'enviroment-variables.mdx',
|
||||
'environment-variables.mdx',
|
||||
);
|
||||
if (envChanged && !envDocsChanged) {
|
||||
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 =
|
||||
'Please review your changes and check if a change needs to be documented!';
|
||||
warn(`${message} - <i>${idea}</i>`);
|
||||
|
Loading…
Reference in New Issue
Block a user