X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=b95ca367e651bb9f18a525b817501dad606411ef;hb=edd7b1256b8b1352fb9c67e79231b0ab24b8dd40;hp=fb1f0f6ec148a0229665f26d3352b2951e79b165;hpb=820299121f09c018a81e9f29c1f38144d97e5e29;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index fb1f0f6ec..b95ca367e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -126,7 +126,7 @@ You can get a complete PeerTube development setup with Gitpod, a free one-click ### Server side -You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code). +You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/contribute-architecture?id=server-code). To develop on the server-side: @@ -141,7 +141,7 @@ restart. ### Client side You can find a documentation of the client code/architecture -[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code). +[here](https://docs.joinpeertube.org/contribute-architecture?id=client-code). To develop on the client side: @@ -216,8 +216,20 @@ Instance configurations are in `config/test-{1,2,3}.yaml`. 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=test npm start` + * 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 +See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins