Add basic env var documentation

This commit is contained in:
TheArcaneBrony
2022-08-07 22:04:24 +02:00
parent 29e88a440f
commit d334340fac
2 changed files with 18 additions and 1 deletions
+17
View File
@@ -0,0 +1,17 @@
#Fosscord Environment Variables:
|NAME|VALUE|DESCRIPTION|
|----|-----|-----------|
|LOG\_REQUESTS | ports to include, or exclude (-) | logs requests |
|PORT|number|sets port number to listen on|
|CDN|string|CDN address|
|GATEWAY|string|Gateway address|
|NODE\_ENV|production/development|sets node environment|
|DATABASE|database url|points to what database to use|
|EVENT\_TRANSMISSION|string|event transmission type|
|STORAGE\_PROVIDER|s3/file|How to store files for CDN|
|STORAGE\_LOCATION|path|Directory to store files in|
|STORAGE\_BUCKET|s3 bucket name|S3 bucket name|
|DB\_UNSAFE|any|Ignores migrations for database, enabled if defined|
|DB\_VERBOSE|any|Log database queries, enabled if defined|
|DB\_MIGRATE|any|Exit fosscord after connecting to and migrating database, used internally|
+1 -1
View File
@@ -92,7 +92,7 @@ function getDataSourceOptions(): DataSourceOptions {
}
function shouldIncludeEntity(name: string): boolean {
return ![
return ![
BaseClassWithoutId,
PrimaryColumn,
BaseClass,