Browse Source

fix : move env variables in installation.md

Signed-off-by: Naveen MR <oof1lab@gmail.com>
pull/506/head
Naveen MR 3 years ago
parent
commit
eae7d8555a
  1. 2
      packages/noco-docs/content/en/getting-started/demos.md
  2. 20
      packages/noco-docs/content/en/getting-started/environment-variables.md
  3. 13
      packages/noco-docs/content/en/getting-started/installation.md

2
packages/noco-docs/content/en/getting-started/demos.md

@ -1,7 +1,7 @@
--- ---
title: 'Demos' title: 'Demos'
description: 'Demos' description: 'Demos'
position: 3 position: 2
category: 'Getting started' category: 'Getting started'
fullscreen: true fullscreen: true
menuTitle: 'Demos' menuTitle: 'Demos'

20
packages/noco-docs/content/en/getting-started/environment-variables.md

@ -1,20 +0,0 @@
---
title: 'Environment Variables'
description: 'Environment Variables'
position: 2
category: 'Getting started'
fullscreen: true
menuTitle: 'Environment Variables'
---
| Variable | Mandatory | Comments | If absent |
|-------------------------|-----------|----------------------------------------------------------------------------------|--------------------------------------------|
| NC_DB | Yes | See our database URLs | A local SQLite will be created in root folder |
| DATABASE_URL | No | JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| |
| DATABASE_URL_FILE | No | path to file containing JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| |
| NC_PUBLIC_URL | Yes | Used for sending Email invitations | Best guess from http request params |
| NC_AUTH_JWT_SECRET | Yes | JWT secret used for auth and storing other secrets | A Random secret will be generated |
| NC_SENTRY_DSN | No | For Sentry monitoring | |
| NC_CONNECT_TO_EXTERNAL_DB_DISABLED | No | Disable Project creation with external database | |
| NC_DISABLE_TELE | No | Disable telemetry | |
| NC_BACKEND_URL | No | Custom Backend URL | ``http://localhost:8080`` will be used |

13
packages/noco-docs/content/en/getting-started/installation.md

@ -261,6 +261,19 @@ aws ecs create-service \
If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules. If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules.
</alert> </alert>
# Environment variables
| Variable | Mandatory | Comments | If absent |
|-------------------------|-----------|----------------------------------------------------------------------------------|--------------------------------------------|
| NC_DB | Yes | See our database URLs | A local SQLite will be created in root folder |
| DATABASE_URL | No | JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| |
| DATABASE_URL_FILE | No | path to file containing JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| |
| NC_PUBLIC_URL | Yes | Used for sending Email invitations | Best guess from http request params |
| NC_AUTH_JWT_SECRET | Yes | JWT secret used for auth and storing other secrets | A Random secret will be generated |
| NC_SENTRY_DSN | No | For Sentry monitoring | |
| NC_CONNECT_TO_EXTERNAL_DB_DISABLED | No | Disable Project creation with external database | |
| NC_DISABLE_TELE | No | Disable telemetry | |
| NC_BACKEND_URL | No | Custom Backend URL | ``http://localhost:8080`` will be used |
## Sample Demos ## Sample Demos

Loading…
Cancel
Save