Page MenuHomePhabricator

Update the template's configuration documentation
Open, Stalled, MediumPublic

Description

[service-template-node](https://github.com/wikimedia/service-template-node) is a template that people use to build micro-services in Node.JS if they intend to deploy them to the WMF production cluster. Each service is configured using the YAML configuration file. Specifically, the template mandates that certain configuration options exist in all of the services.

We have some existing configuration documentation, but it is outdated. We need to document all of the configuration options required or supplied by the template, ideally in the form of a table:

NameRequiredDefaultDescription
portno6927the port the service listens on

The documentation should be added directly to the configuration documentation on mediawiki.org. The code that manipulates the shared configuration options is here and here.