]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/commitdiff
Add info on dev env variables
authorChocobozzz <me@florianbigard.com>
Thu, 7 Jul 2022 06:27:27 +0000 (08:27 +0200)
committerChocobozzz <me@florianbigard.com>
Thu, 7 Jul 2022 06:27:27 +0000 (08:27 +0200)
.github/CONTRIBUTING.md

index e8570dd2b96d390b6fdb4b7d0630e4d51602d819..b95ca367e651bb9f18a525b817501dad606411ef 100644 (file)
@@ -218,6 +218,18 @@ To test emails with PeerTube:
  * Run [mailslurper](http://mailslurper.com/)
  * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server`
 
+### Environment variables
+
+PeerTube can be configured using environment variables.
+See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables
+
+Additionally to these ones, we provide some environment for dev/test purpose:
+
+ * `PRODUCTION_CONSTANTS=true`: in `NODE_ENV=dev` or `NODE_ENV=test` PeerTube customizes some constants. To prevent this behaviour, you can set `PRODUCTION_CONSTANTS` env to
+ `true`
+ * `PEERTUBE_LOCAL_CONFIG`: directory to find the local configuration file (used by web admin)
+ * `NODE_DB_LOG=false`: disable SQL request logging
+
 ## Plugins & Themes
 
 See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins