README.md

robototes-website-web

About

This repository is a Docker microservice that contains the public pages of the Robototes' Website. This includes parts of the website such as the homepage, the about page, and the contact us page.

For common documentation regarding the requirements, upkeep, and testing of our microservices, please see our global documentation. Sections regarding microservice-specific configuration, features, and differences in commands can be found below.

Configuring the server

The following environment variables can be set, the server will not start without the ones marked required:

• IP (required, default 0.0.0.0) The IP to run the server on
• PORT (required, default 3000) The port to listen for requests on
• DOMAIN (required) The second-level domain that the server resides on
• G_TRACKING_ID (required) The Google analyics tracking ID to report to
• DEBUG (optional) see Debug mode
• DATABASE_HOST (required) The IP address that the MongoDB server is listening on
• DATABASE_PORT (required) The port that the MongoDB server is listening on

Report URI

This site has been configured to use report-uri.com to track CSP and Expect-CT violations, and the violations can be viewed by logging in at report-uri.com. The report URI can be modified to report to a different location by changing the values in middleware.js.

Debug mode

Refer to our common documentation for an overview of debug mode. In this microservice, debug mode changes the following:

• Sets /robots.txt to the debug version set in the seo.js config
• Disables page caching
• Enables extra information on error pages
• Enables Pug debug mode
• Enables the Google Analytics debug mode

The recommended debug filter for this project is robototes-website-web:*,http.

Maintainers

@dannytech and @TAKBS2412

Contributing/Vulnerability disclosure

See our common CONTRIBUTING.md

License