diff options
author | Chocobozzz <me@florianbigard.com> | 2022-07-07 08:27:27 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2022-07-07 08:27:27 +0200 |
commit | edd7b1256b8b1352fb9c67e79231b0ab24b8dd40 (patch) | |
tree | 39c15a706bd0f83dde1e7d368f290aa2ac1165f2 /.github | |
parent | 17d85f48b51ef7dad747f7471c8237320e40e2a4 (diff) | |
download | PeerTube-edd7b1256b8b1352fb9c67e79231b0ab24b8dd40.tar.gz PeerTube-edd7b1256b8b1352fb9c67e79231b0ab24b8dd40.tar.zst PeerTube-edd7b1256b8b1352fb9c67e79231b0ab24b8dd40.zip |
Add info on dev env variables
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 12 |
1 files changed, 12 insertions, 0 deletions
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: | |||
218 | * Run [mailslurper](http://mailslurper.com/) | 218 | * Run [mailslurper](http://mailslurper.com/) |
219 | * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server` | 219 | * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server` |
220 | 220 | ||
221 | ### Environment variables | ||
222 | |||
223 | PeerTube can be configured using environment variables. | ||
224 | See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables | ||
225 | |||
226 | Additionally to these ones, we provide some environment for dev/test purpose: | ||
227 | |||
228 | * `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 | ||
229 | `true` | ||
230 | * `PEERTUBE_LOCAL_CONFIG`: directory to find the local configuration file (used by web admin) | ||
231 | * `NODE_DB_LOG=false`: disable SQL request logging | ||
232 | |||
221 | ## Plugins & Themes | 233 | ## Plugins & Themes |
222 | 234 | ||
223 | See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins | 235 | See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins |