From edd7b1256b8b1352fb9c67e79231b0ab24b8dd40 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Thu, 7 Jul 2022 08:27:27 +0200 Subject: [PATCH] Add info on dev env variables --- .github/CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e8570dd2b..b95ca367e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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