Add basic env var documentation
2 files changed, 18 insertions, 1 deletions
diff --git a/env-vars.md b/env-vars.md
new file mode 100644
index 00000000..c24ea1a2
--- /dev/null
+++ b/env-vars.md
@@ -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|
\ No newline at end of file
diff --git a/util/src/util/Database.ts b/util/src/util/Database.ts
index 26ac794e..d0d39f4c 100644
--- a/util/src/util/Database.ts
+++ b/util/src/util/Database.ts
@@ -92,7 +92,7 @@ function getDataSourceOptions(): DataSourceOptions {
}
function shouldIncludeEntity(name: string): boolean {
- return 