104 lines
3.9 KiB
Plaintext
104 lines
3.9 KiB
Plaintext
---
|
|
title: Enviroment Variables
|
|
sidebar_position: 1
|
|
sidebar_custom_props:
|
|
icon: TbVariable
|
|
---
|
|
|
|
import OptionTable from '@site/src/theme/OptionTable'
|
|
|
|
## Frontend
|
|
|
|
<OptionTable options={[
|
|
['REACT_APP_SERVER_BASE_URL', 'http://localhost:3000', 'Url of backend server'],
|
|
['REACT_APP_SERVER_AUTH_URL', 'http://localhost:3000/auth', 'Auth Url of backend server'],
|
|
['REACT_APP_SERVER_FILES_URL', 'http://localhost:3000/files', 'Files Url of backend server'],
|
|
['GENERATE_SOURCEMAP', 'false', 'Generate source maps for debugging'],
|
|
['CHROMATIC_PROJECT_TOKEN', '', 'Chromatic token used for CI'],
|
|
]}></OptionTable>
|
|
|
|
|
|
## Backend
|
|
|
|
### Config
|
|
|
|
<OptionTable options={[
|
|
['PG_DATABASE_URL', 'postgres://user:pw@localhost:5432/default?connection_limit=1', 'Database connection'],
|
|
['REDIS_HOST', '127.0.0.1', 'Redis connection host'],
|
|
['REDIS_PORT', '6379', 'Redis connection port'],
|
|
['FRONT_BASE_URL', 'http://localhost:3001', 'Url to the hosted frontend'],
|
|
['SERVER_URL', 'http://localhost:3000', 'Url to the hosted server'],
|
|
['PORT', '3000', 'Port'],
|
|
]}></OptionTable>
|
|
|
|
### Tokens
|
|
|
|
<OptionTable options={[
|
|
['ACCESS_TOKEN_SECRET', '<random>', 'Secret used for the access tokens'],
|
|
['ACCESS_TOKEN_EXPIRES_IN', '30m', 'Access token expiration time'],
|
|
['LOGIN_TOKEN_SECRET', '<random>', 'Secret used for the login tokens'],
|
|
['LOGIN_TOKEN_EXPIRES_IN', '15m', 'Login token expiration time'],
|
|
['REFRESH_TOKEN_SECRET', '<random>', 'Secret used for the refresh tokens'],
|
|
['REFRESH_TOKEN_EXPIRES_IN', '90d', 'Refresh token expiration time'],
|
|
['REFRESH_TOKEN_COOL_DOWN', '1m', 'Refresh token cooldown'],
|
|
['API_TOKEN_EXPIRES_IN', '1000y', 'Api token expiration time'],
|
|
]}></OptionTable>
|
|
|
|
### Auth
|
|
|
|
<OptionTable options={[
|
|
['MESSAGING_PROVIDER_GMAIL_ENABLED', 'false', 'Enable Gmail API connection'],
|
|
['MESSAGING_PROVIDER_GMAIL_CALLBACK_URL', '', 'Gmail auth callback'],
|
|
['AUTH_GOOGLE_ENABLED', 'false', 'Enable Goole SSO login'],
|
|
['AUTH_GOOGLE_CLIENT_ID', '', 'Google client ID'],
|
|
['AUTH_GOOGLE_CLIENT_SECRET', '', 'Google client secret'],
|
|
['AUTH_GOOGLE_CALLBACK_URL', '', 'Google auth callback'],
|
|
['FRONT_AUTH_CALLBACK_URL', 'http://localhost:3001/verify ', 'Callback used for Login page'],
|
|
]}></OptionTable>
|
|
|
|
### Storage
|
|
|
|
<OptionTable options={[
|
|
['STORAGE_TYPE', 'local', "Storage driver: 'local' or 's3'"],
|
|
['STORAGE_S3_REGION', '', 'Storage Region'],
|
|
['STORAGE_S3_NAME', '', 'Bucket Name'],
|
|
['STORAGE_S3_ENDPOINT', '', 'Use if a different Endpoint is needed (for example Google)'],
|
|
['STORAGE_LOCAL_PATH', '.local-storage', 'data path (local storage)'],
|
|
]}></OptionTable>
|
|
|
|
### Message Queue
|
|
|
|
<OptionTable options={[
|
|
['MESSAGE_QUEUE_TYPE', 'pg-boss', "Queue driver: 'pg-boss' or 'bull-mq'"],
|
|
]}></OptionTable>
|
|
|
|
### Logging
|
|
|
|
<OptionTable options={[
|
|
['LOGGER_DRIVER', 'console', "The logging driver can be: 'console' or 'sentry'"],
|
|
['LOG_LEVEL', 'error,warn', "The loglevels which are logged to the logging driver. Can include: 'log', 'warn', 'error'"],
|
|
['SENTRY_DSN', 'https://xxx@xxx.ingest.sentry.io/xxx', 'The sentry logging endpoint used if sentry logging driver is selected'],
|
|
]}></OptionTable>
|
|
|
|
### Support
|
|
|
|
|
|
<OptionTable options={[
|
|
['SUPPORT_DRIVER', 'front', "Support driver ('front' or 'none')"],
|
|
['SUPPORT_FRONT_HMAC_KEY', '<secret>', 'Suport chat key'],
|
|
['SUPPORT_FRONT_CHAT_ID', '<id>', 'Support chat id'],
|
|
]}></OptionTable>
|
|
|
|
### Telemetry
|
|
<OptionTable options={[
|
|
['TELEMETRY_ENABLED', 'true', 'Change this if you want to disable telemetry'],
|
|
['TELEMETRY_ANONYMIZATION_ENABLED', 'true', 'Telemetry is anonymized by default, you probably don\'t want to change this'],
|
|
]}></OptionTable>
|
|
|
|
### Debug / Development
|
|
|
|
<OptionTable options={[
|
|
['DEBUG_MODE', 'true', 'Activate debug mode'],
|
|
['SIGN_IN_PREFILLED', 'true', 'Prefill the Signin form for usage in a demo or dev enviroment'],
|
|
]}></OptionTable>
|