robototes-website-team

About

This repository is a Docker microservice devoted to the team-only section of the Robototes' Website. The team-only section contains helpful resources, internal announcements, and much more that can only be accessed by members of the Robototes via login.

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
• AUTH0_CLIENT_ID (required) see Auth0
• AUTH0_DOMAIN (required) see Auth0
• AUTH0_CLIENT_SECRET (required) see Auth0
• 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

HPKP Hashes

HPKP, or HTTPS Public Key Pinning, is a whitelist for the certificates, intermediary CAs, and CAs so that our cert cannot be replaced by another others. The following is the recommended set to include:

• lCppFqbkrlJ3EcVFAkeip0+44VaoJUymbnOaEUk7tEU= (AddTrust External CA Root)
• 58qRu/uxh4gFezqAcERupSkRYBlBAvfcw7mEjGPLnNU= (Comodo ECC CA)
• grX4Ta9HpZx6tSHkmCrvpApTQGo67CYDnvprLg5yRME= (Comodo RSA CA)
• klO23nT2ehFDXCfx3eHTDRESMz3asj1muO+4aIdjiuY= (Comodo RSA Domain Validation Secure Server CA)
• x9SZw6TwIqfmvrLZ/kz1o0Ossjmn728BnBKpUFqGNVM= (Comodo ECC Domain Validation Secure Server CA)
• tey1EE7fk3hATntrqvJd0pRDLpjqawZ7YSlOiA/staQ= (sni32250.cloudflaressl.com, for robototes.com)

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

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

Auth0

We use Auth0 to authenticate team members to private sections of our website. By letting Auth0 handle logins, we don't have to worry about storing passwords, and we can simply use a polished and easy-to-implement system to handle our authentication.

Maintainers

@dannytech and @TAKBS2412

Contributing/Vulnerability disclosure

See our common CONTRIBUTING.md

License