X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=75557865e6fce920b3aac049e7af3abaa2acabb4;hb=647c2b7d0448e68d8c8ade52d9568e9b33f8638d;hp=e8570dd2b96d390b6fdb4b7d0630e4d51602d819;hpb=9452d4fd3321148fb80b64a67bd9983fee6c208e;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e8570dd2b..75557865e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -116,6 +116,9 @@ $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev ``` +Peertube also requires a running redis server, no special setup is needed for +this. + In dev mode, administrator username is **root** and password is **test**. ### Online development @@ -218,6 +221,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